A special thanks to Mojib Wali of CyVerse-Austria, Graz University of Technology, Austria, for creating these Material MkDocs pages for the global CyVerse developer and maintainer community!

These documents are for the deployment and maintenence of CyVerse

The main branch uses deploy-mkdocs GitHub Action.

Do not commit changes directly to the main branch unless necessary. Please commit your updates to the mkdocs branch, test on CodeSpaces or locally, and then commit those merges back to main.

Commits to main will trigget the Action which re-builds and deploys the website to https://docs.cyverse.org -- which is publicly available.

To change to MkDocs Material theme, change Action to @master and set theme: material in the mkdocs.yml:

theme:
  name: material

git clone https://github.com/cyverse/docs
cd docs
pip install -r requirements.txt
python -m mkdocs serve

After compiling the new pages the service will open on http://localhost:8000/docs

Open in browser and view

Recommended: two monitors for easier display while working on docs.