Skip to content

Commit b002664

Browse files
explain building site incl. PDF using mike set-default
1 parent 7c468dd commit b002664

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

Diff for: README.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,26 @@ Please file your bug reports, enhancement requests, questions and other support
4141
3. [Create a branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/), commit and publish your changes and enhancements
4242
4. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/)
4343

44-
## How to Build the HTML Site and PDF Documenation
44+
## How to Build the HTML Site
4545

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

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

0 commit comments

Comments
 (0)