Skip to content

Commit

Permalink
docs: move adv stuff out of readme (#125)
Browse files Browse the repository at this point in the history
  • Loading branch information
wesleyboar authored Feb 6, 2025
1 parent 96c97f2 commit e463dd3
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
12 changes: 12 additions & 0 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# How to Develop

Manage dependencies via [TACC/TACC-Docs](https://github.com/TACC/TACC-Docs). Serve docs via [MkDocs](https://www.mkdocs.org/). Test via [Docker](https://www.docker.com/). Deploys are [automated](./PUBLISHING.md).

## Theming

Customize MkDocs with [CSS, JS, ES, plugins, extensions](https://github.com/TACC/TACC-Docs/blob/v0.15.0/mkdocs.base.yml) and [theme overrides](https://github.com/TACC/TACC-Docs/tree/v0.15.0/themes/tacc-readthedocs) **from [TACC/TACC-Docs](https://github.com/TACC/TACC-Docs)** both via [script](./bin/tacc-setup.sh) and [via Docker](./Dockerfile).

To theme another MkDocs project to look [like this](https://docs.tacc.utexas.edu/), please contact [@wesleyboar](https://www.github.com/wesleyboar).

> [!NOTE]
> We will eventually [use MkDocs Material](https://github.com/TACC/TACC-Docs/issues/53) and [apply TACC customization properly](https://github.com/TACC/TACC-Docs/issues/76).
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ Testing is manual and requires using a command prompt. You can test [via Python]

We automatically publish `main` branch commits. We manually release versions of DS-User-Guide. [Read more](./PUBLISHING.md).

## Theming
## Developing

To theme your documentation like this project, please contact [@wesleyboar](https://www.github.com/wesleyboar) or mimic [DS-User-Guide](https://github.com/DesignSafe-CI/DS-User-Guide/).
We use [Poetry](https://python-poetry.org/), [Docker](https://www.docker.com/), [MkDocs](https://mkdocs.readthedocs.io/) and a customized theme. [Read more](./DEVELOPING.md).
2 changes: 1 addition & 1 deletion TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

### B. Via Docker

0. Have Docker installed.\
0. Have [Docker](https://www.docker.com/) installed.\
<sup>We recommend doing so via [Docker-Desktop](https://www.docker.com/products/docker-desktop).</sup>
1. Navigate into your clone of this repository.
2. Start the Docker container to serve the docs.
Expand Down

0 comments on commit e463dd3

Please sign in to comment.