We're using Material for MkDocs for documentation, with the mike plugin for versioning.
The latest version of the documents, which is the default, should only ever be
built from the main branch, and should always be deployed to the gh-pages
branch of the sandialabs/sceptre-phenix-docs repository (referenced here as
the upstream remote).
git remote add upstream [email protected]:sandialabs/sceptre-phenix-docs.git
git checkout main
./mkdocs-helper.sh deploy --branch gh-pages latest
git push upstream gh-pages:gh-pages
The dev version of the documents is meant to contain draft documentation for
any phenix or phenix-apps branches currently being worked on. The workflow for
doing so should be as follows:
- Create a branch in this repo that contains draft documentation. This should
not be done in the
devbranch directly so drafts can be iteratively merged into themainbranch. - Merge the draft branch into the
devbranch. - From the
devbranch, run./mkdocs-helper.sh deploy --branch gh-pages dev. - Deploy the updated development docs by running
git push upstream gh-pages:gh-pages.
It's also possible to create a new version per draft branch if the situation warrants.