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

CyVerse Core Software Documentation

These documents are for the deployment and maintenance of CyVerse

Zensical Static Site Generator

This documentation is built using Zensical, a modern static site generator from the team behind Material for MkDocs. The site uses Zensical's "classic" theme which provides the familiar Material for MkDocs appearance with enhanced features.

GitHub Actions Deployment

The main branch uses GitHub Actions to automatically build and deploy the documentation.

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 trigger the Action which re-builds and deploys the website to https://docs.cyverse.org -- which is publicly available.

Configuration

The documentation is configured using zensical.toml (TOML format) instead of the traditional mkdocs.yml. This provides better configuration management and access to Zensical-specific features.

Local Development

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

After starting the development server, the site will open at http://localhost:8000

Open in browser and view

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

Building

To build the static site:

zensical build

Output will be in the ./site directory.