Skip to content

Commit 808ade8

Browse files
add section: how to build the HTML site and PDF documentation
1 parent c912351 commit 808ade8

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,25 @@ Please file your bug reports, enhancement requests, questions and other support
3737
3. [Create a branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/), commit and publish your changes and enhancements
3838
4. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/)
3939

40+
## How to Build the HTML Site and PDF Documenation
41+
42+
1. Install Docker in your environment
43+
* [Install Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/)
44+
* [Install Docker Desktop on Windows](https://docs.docker.com/docker-for-windows/install/)
45+
* [Install Docker Server on Linux](https://docs.docker.com/install/#server)
46+
2. [Fork this respository](https://github.com/trivadis/plsql-and-sql-coding-guidelines/fork)
47+
3. Check/change the version in [mkdocs.yml](mkdocs.yml)
48+
4. Open termin in [tools](tools) folder
49+
* Deploy into a version folder
50+
run `./mike.sh deploy <version>`. `<version>` represents the folder name, e.g. `master` or `v3.4`.
51+
* Deploy into default folder
52+
run `./gh-deploy.sh`
53+
* Set default version (latest)
54+
run `./mike.sh set-default <version>`.
55+
* Build the PDF file
56+
run `./genpdf.sh`.
57+
5. `commit` changes and `push` all branches.
58+
4059
## Related Resources
4160
* [DOAG PL/SQL Conventions](https://github.com/Doag/PL-SQL-Conventions)
4261

0 commit comments

Comments
 (0)