From 55a702dbc0ef51acdfb2284fcbdec3c1444dcf71 Mon Sep 17 00:00:00 2001 From: Wesley B <62723358+wesleyboar@users.noreply.github.com> Date: Mon, 10 Jun 2024 14:19:29 -0500 Subject: [PATCH] docs(README): improvements from TACC-Docs --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e49d2dd2..636e26cd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # DesignSafe User Guide -DesignSafe ReadTheDocs Documentation with [MkDocs](https://mkdocs.readthedocs.io/). +DesignSafe [MkDocs](https://mkdocs.readthedocs.io/) documentation with **customized** [ReadTheDocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) theme. ## Contributing @@ -17,6 +17,14 @@ DesignSafe ReadTheDocs Documentation with [MkDocs](https://mkdocs.readthedocs.io 6. [Test](#testing) your changes.\ (if comfortable using a command prompt) +### Resources + +* [Markdown syntax (extended)](https://www.markdownguide.org/extended-syntax/) via [MkDocs' Markdown support](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown) + - plus some[^1] enabled [Python-Markdown extensions](https://python-markdown.github.io/extensions/) + - plus some[^1] enabled [PyMdown exensions](https://facelessuser.github.io/pymdown-extensions/#extensions) + +[^1]: Which extensions are enabled is tracked by https://github.com/TACC/TACC-Docs/blob/main/mkdocs.base.yml under `markdown_extensions:`. + ## Testing - [A. Via Python](#a-via-python) @@ -67,8 +75,19 @@ DesignSafe ReadTheDocs Documentation with [MkDocs](https://mkdocs.readthedocs.io 3. Open the website at the URL provided e.g. [http://0.0.0.1:8000/user-guide/](http://0.0.0.1:8000/user-guide/). + +[^2]: To manually build or deploy, consult [our internal documentation](https://tacc-main.atlassian.net/wiki/x/aBhv). + +## Automatic Builds + +Automatic builds (not deploys) should occur on pushes to any branch.[^2] + +## Automatic Deployment + +Automatic deploys should occur after an automatic build on the `main` branch.[^2] + ## 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/ +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/](https://designsafeci-dev.tacc.utexas.edu/user-guide/).