|
| 1 | +# How to Contribute |
| 2 | + |
| 3 | +This is a GitHub repo for the [Roar User Guide] in Markdown format using mkdocs. |
| 4 | + |
| 5 | +The live documentation is hosted from the `main` branch. This branch is protected and |
| 6 | +changes can only be proposed via pull requests. This can be viewed at https://docs.icds.psu.edu |
| 7 | + |
| 8 | +There is also a `staging` branch which can be viewed at https://docs.icds.psu.edu/staging |
| 9 | +Any changes made to the `staging` branch will be incorporated into the site every 5 minutes. If the change does not show or the site becomes inoperable, it is likely due to an error in the code sent. |
| 10 | + |
| 11 | + |
| 12 | +## Recommended Workflow: |
| 13 | + |
| 14 | +To prevent conflicts with others, it is recommended to create your own fork of the repository and |
| 15 | +work on changes there. |
| 16 | + |
| 17 | +You can preview changes locally by following these steps: |
| 18 | + |
| 19 | +1. Install necessary tools on your local machine |
| 20 | + - Python - https://www.python.org/downloads/release/python-3132/ |
| 21 | + - mkdocs - https://www.mkdocs.org/user-guide/installation/ |
| 22 | + - PyMdown - https://facelessuser.github.io/pymdown-extensions/installation/ |
| 23 | + |
| 24 | +1. Clone your repository fork (or create a new branch on the PSU-ICDS repo) |
| 25 | +1. Commit desired modifications |
| 26 | +1. Build the site: `mkdocs build` |
| 27 | +1. Start the server: `mkdocs serve` |
| 28 | +1. View the site in your browser: http://127.0.0.1:8000/en/latest/ |
| 29 | + |
| 30 | +Once you are satisfied with the changes, create a pull request to the staging branch. Once the PR is approved and merged, |
| 31 | +the changes will be reflected in the staging site. |
| 32 | + |
| 33 | +Once the changes are approved and checked via the staging portal, submit a pull request to the main branch to have the changes integrated into the live site. |
| 34 | + |
| 35 | +## Helpful links: |
| 36 | + |
| 37 | +- https://www.mkdocs.org/user-guide/ |
| 38 | +- https://www.markdownguide.org/tools/mkdocs/ |
| 39 | + |
| 40 | +Converters: |
| 41 | +- [HTML -> Markdown](https://www.browserling.com/tools/html-to-markdown) |
| 42 | +- [HTML table -> Markdown](https://jmalarcon.github.io/markdowntables/) |
| 43 | + |
| 44 | +[//]:<> (Admonition options: https://squidfunk.github.io/mkdocs-material/reference/admonitions/) |
0 commit comments