DesignSafe User Guide

DesignSafe ReadTheDocs Documentation with MkDocs.

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. Request a review.
   ^{(a.k.a. create a "Pull Request")}
5. _{(if comfortable using a command prompt)}
   Test your changes.

Local Testing

• A. Via Python
• B. Via Docker

A. Via Python

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

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

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.

   make build
   make start
   

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

Releases

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

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