https://github.com/sandialabs/sceptre-phenix-docs

phenix documentation
https://github.com/sandialabs/sceptre-phenix-docs

scr-2646

Last synced: 2 days ago
JSON representation

phenix documentation

• Host: GitHub
• URL: https://github.com/sandialabs/sceptre-phenix-docs
• Owner: sandialabs
• Created: 2021-04-15T17:26:32.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-13T20:57:24.000Z (9 months ago)
• Last Synced: 2024-06-14T00:19:14.977Z (5 months ago)
• Topics: scr-2646
• Language: HTML
• Homepage:
• Size: 7.02 MB
• Stars: 2
• Watchers: 5
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# phenix Documentation

We're using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)

for documentation, with the [mike](https://github.com/jimporter/mike) plugin for

versioning.

## Deploy Latest Documentation

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

```

## Deploy Branch Documentation

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:

1. Create a branch in this repo that contains draft documentation. This should

   not be done in the `dev` branch directly so drafts can be iteratively merged

   into the `main` branch.

2. Merge the draft branch into the `dev` branch.

3. From the `dev` branch, run `./mkdocs-helper.sh deploy --branch gh-pages dev`.

4. 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.