Skip to content

Commit c0bd609

Browse files
committed
Fixed the build of gh pages.
Update of readme and index.md file
1 parent 1ac2086 commit c0bd609

File tree

3 files changed

+19
-26
lines changed

3 files changed

+19
-26
lines changed

.github/workflows/build_pages.yml

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ jobs:
99
runs-on: ubuntu-latest
1010
steps:
1111
- uses: actions/checkout@v4
12+
with:
13+
fetch-depth: 0
1214
- uses: actions/setup-python@v2
1315
with:
1416
python-version: 3.x

README.md

+11-26
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
# Maintaining the utPLSQL Website
22

3-
43
The [utPLSQL website](https://utplsql.github.io) is generated using [MkDocs](https://www.mkdocs.org/) and [material theme](https://squidfunk.github.io/mkdocs-material)
54
[Mike](https://github.com/jimporter/mike) is used for versioning of documentation see also [this page](https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/)
65

6+
## How to make an announcement post.
7+
8+
- Create a new post file in the [docs/_posts](https://github.com/utPLSQL/utPLSQL.github.io/tree/main/docs/_posts) directory with the file name of `YYYY-MM-DD-Blog-Post-Name.md` This file will be a standard [Markdown file](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) which can be editing with any text editor although there are many offline and online editors for Markdown.
9+
- Add new entry pointing to new announcement file to the start of `nav` section in `mkdocs.yml`
10+
- Add new entry to the top of `index.md`
11+
- Commit and push changes to develop branch
712

813
## Local setup
914

10-
You will need to have python installed along with pip (see [this page](https://squidfunk.github.io/mkdocs-material/getting-started/))
15+
If you want to generate and preview the website locally, you will need to have [python and pip installed](https://squidfunk.github.io/mkdocs-material/getting-started/))
1116

12-
Once you have pytin and pip installed you will need to install the three components:
17+
To install mkdocs required components, you need to execute the below commands from command line:
1318
```
1419
pip install mkdocs-material
1520
pip install mkdocs-git-revision-date-localized-plugin
@@ -20,9 +25,10 @@ pip install mike
2025
Once installed you can use following commands from command line:
2126

2227
`mkdocs serve` - will stat a local server, so you can see the web page generated locally and tet real-time updates to documentation
23-
`mkdocs gh-deploy` - will deploy changed documentation into repository (if you have privileges).
24-
2528

29+
The pages are automatically generated on every commit to the `main` branch.
30+
If however you would need to generate pages manually from your local copy, use the command:
31+
`mkdocs gh-deploy`.
2632
The generated web pages are hen visible at [utplsql.org](https://utPLSQL.org).
2733

2834
Individual project documentation pages are deployed separately from the main organization page.
@@ -37,24 +43,3 @@ Example commands to use are:
3743
- `mike deploy -p develop` - to deploy and push documentation for develop branch
3844
- `mike deploy -p -u v3.1.12 latest` - to deploy and push documentation for version v3.1.12 and update the `latest` alias to point to that version
3945

40-
41-
## How to make an announcement post.
42-
43-
- Create a File in the [docs/_posts](https://github.com/utPLSQL/utPLSQL.github.io/tree/main/docs/_posts) directory with the file name of `YYYY-MM-DD-Blog-Post-Name.md` This file will be a standard [Markdown file](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) which can be editing with any text editor although there are many offline and online editors for Markdown.
44-
- Add new entry pointing to new announcement file to the start of `nav` section in `mkdocs.yml`
45-
- Add new entry to the top of `index.md`
46-
47-
## How to preview site locally
48-
49-
Jekyll will allow you to preview the site locally doing the following:
50-
51-
1. [Install Jekyll 3](https://jekyllrb.com/docs/installation/)
52-
2. [Use Jekyll Serve](https://jekyllrb.com/docs/usage/)
53-
54-
55-
56-
57-
58-
59-
60-

docs/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
----------------------------------------------------------------------
22

3+
^2024-02-19^
4+
5+
[version 3.1.14 released](_posts/2024-02-19-version3.1.14-released.md)
6+
7+
----------------------------------------------------------------------
8+
39
^2022-12-11^
410

511
[version 3.1.13 released](_posts/2022-12-11-version3.1.13-released.md)

0 commit comments

Comments
 (0)