Documentation

CDDS uses an X.Y.Z versioning system for releases but for documentation we only publish the most recent bugfix release. For example, we would publish 1.0.0 as 1.0 and any following bugfix releases e.g., 1.0.1 would overwrite that existing 1.0 deployment.

It is also not necessary to only publish the documentation as part of the release process. If documentation needs to be added or corrected this can be done independently of a release, as long as it does not reference any change or functionality that has not yet been released.

Deployment Procedure

Checkout the required release branch for deployment.
```
git checkout vX.Y_release
```
Confirm the branch is up to date.
```
git pull
```
Active the CDDS environment.
```
source setup_env_for_devel
```
Inspect the current list of deployed versions.
```
mike list 
```
Deploy the new/updated version of the documentation. (This command should overwrite any existing existing deployments with the same name.)
```
mike deploy X.Y
```
Verify the new deployment works as expected.
```
mike serve
```
Push the local commit made by mike to the gh-pages branch to GitHub.
```
git push origin gh-pages
```

How to set the latest version

The latest version of the documentation pages that is shown by default should be always the latest major release version e.g. 3.1. If a new major release is done, then you need to tell mike that the latest version has be changed:

Deploy the newest latest documentation:
```
mike deploy X.Y latest --update-aliases
```
where X.Y is the version of the major release you like to have as default e.g 3.1
Verify the default documentation is set as expected:
```
mike serve
```
Push the local commit by mike to the gh-pages branch to GitHub:
```
git push origin gh-pages
```