DesignSafe-CI/DS-User-Guide

User Guide for DesignSafe

DesignSafe User Guide

DesignSafe MkDocs documentation with customized ReadTheDocs theme.

Contributing

Note

For a detailed walkthrough of how to contribute to Use Cases, see its README.

1. Fork this repository.
   ^{(unless you are a direct collaborator)}
2. Edit relevant files that need update.
   ^{(upload images as necessary)}
3. Commit your changes.
4. Test your changes.
   ^{(if comfortable using a command prompt)}
5. Request a review.
   ^{(a.k.a. create a "Pull Request")}

Resources

• Markdown syntax (extended) via MkDocs' Markdown support
  • plus some¹ enabled Python-Markdown extensions
  • plus some¹ enabled PyMdown exensions

Testing

• A. Via Python
• B. Via Docker

A. Via Python

Note

This solution uses a different theme than https://designsafe-ci.org/user-guide/. See issue #42 for details.

0. Have Python installed.
   ^{Known supported versions are from 3.10 to 3.12.}
1. Navigate into your clone of this repo.
2. Install dependencies:
   ^{You should only need to do this once, or after a new release.}

   ./bin/tacc-setup.sh
   pip install poetry
   

3. Isolate dependencies:

   poetry shell
   

4. Update & Serve the docs:

   poetry install
   cd user-guide
   mkdocs serve
   

   ^{After the poetry shell command, you should be in a Poetry-managed environment. Your prompt might be prefixed with the name of the environment.}
5. Open the website at the URL echoed by the program e.g. http://127.0.0.1:8000/user-guide/.

B. Via Docker

0. Have Docker installed.
   ^{We recommend doing so via Docker-Desktop.}

1. Navigate into your clone of this repository.

2. Start the Docker container to serve the docs.

   Linux or Mac (macOS) user:

    make build
    make start
   

   Windows user:

    docker-compose -f docker-compose.yml build
    docker-compose -f docker-compose.yml up
   

3. Open the website at the URL provided e.g. http://0.0.0.1:8000/user-guide/.

Automatic Builds

Automatic builds (not deploys) should occur on pushes to any branch.²

Automatic Deployment

Automatic deploys should occur after an automatic build on the main branch.²

Releases

All commits to main will trigger a docker build and push a new image to designsafeci/ds-user-guide:latest.

A Watchtower service monitors new pushes to this dockerhub repo and pull down new images on the fly to https://designsafeci-dev.tacc.utexas.edu/user-guide/.

Footnotes

1. Enabled extensions are tracked by https://github.com/TACC/TACC-Docs/blob/main/mkdocs.base.yml under markdown_extensions:. ↩ ↩²

2. To manually build or deploy, consult our internal documentation. ↩ ↩²