Welcome to DAS IT Documentation

Adding/Editing Documents

Git setup

Clone the Github repository at https://github.com/OregonDAS-IS/SolutionsMkDocs using your git tool of choice.

Create a new branch, based on main, called

<your initials>/<name_of_change>

All new documents and should be put into /frontend/docs and all images should go in fronted/docs/images in the same folder structure as used for documents.

Links to images in documents should be relative, not absolute.

Then, modify /fronted/mkdocs.yml to put your new documents into the site navigation. Maintain alphabetical order inside each section.

Preview Changes

To preview your changes to the site, first install python from software center.

Then run

pip install mkdocs
pip install mkdocs-material
pip install mkdocs-glightbox

to setup mkdocs locally. Then run

mkdocs serve

to run documentation site in editing mode at http://127.0.0.1:8000/ Changes made to the documentation will be picked up and the local site updated as you edit.

Saving Changes to Site

Commit your changes and push your banch up to Github.

Then at https://github.com/OregonDAS-IS/SolutionsMkDocs/pulls create a new Pull Request to merge your change branch into the main branch. Once your Pull Request is reviewed and merged, your changes will appear on the docs website.