Skip to content

Commit

Permalink
explain building site incl. PDF using mike set-default
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippSalvisberg committed Sep 21, 2019
1 parent 7c468dd commit b002664
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,22 +41,26 @@ Please file your bug reports, enhancement requests, questions and other support
3. [Create a branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/), commit and publish your changes and enhancements
4. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/)

## How to Build the HTML Site and PDF Documenation
## How to Build the HTML Site

1. Install Docker in your environment
* [Install Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/)
* [Install Docker Desktop on Windows](https://docs.docker.com/docker-for-windows/install/)
* [Install Docker Server on Linux](https://docs.docker.com/install/#server)
2. [Fork this respository](https://github.com/trivadis/plsql-and-sql-coding-guidelines/fork)
3. Check/change the version in [mkdocs.yml](mkdocs.yml)
4. Open a terminal in the [tools](tools) folder
* Deploy version site
run `./mike.sh deploy <version>`. `<version>` represents the folder name, e.g. `master` or `v3.4`.
* Set default version (redirect to chosen `<version>`, should be latest)
run `./mike.sh set-default <version>`.
* Build the PDF file
3. For Windows users only
* Enable Windows to run Bash Shell, using one of the four options described [here](https://itsfoss.com/run-linux-commands-in-windows/).
4. Check/change the version in [mkdocs.yml](mkdocs.yml)
5. Open a terminal window in the [tools](tools) folder
* Build/update the PDF file
run `./genpdf.sh`.
5. `commit` changes and `push` all branches.
* Test the HTML site locally
run `./serve.sh` and open [http://localhost:8000](http://localhost:8000)
* Deploy HTML site
run `./mike.sh deploy master`.
* Set default version (HTML redirect)
run `./mike.sh set-default master`.
6. `commit` changes and `push` all branches.

## Related Resources
* [DOAG PL/SQL Conventions](https://github.com/Doag/PL-SQL-Conventions)
Expand Down

0 comments on commit b002664

Please sign in to comment.