-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: move advanced stuff out of readme (#77)
* docs: move advanced stuff out of readme We shoudl welcome new contributors, not confuse nor worry them. * docs(README): move more dev stuff to bottom * docs(README): remove excess detail from "Developing" * docs(DEVELOPING): terser content
- Loading branch information
1 parent
5b0320c
commit f586e54
Showing
3 changed files
with
20 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# How to Develop | ||
|
||
Manage dependencies via [Poetry](https://python-poetry.org/). Serve docs via [MkDocs](https://www.mkdocs.org/). Test via [Docker](https://www.docker.com/). Deploys are [automated](https://github.com/TACC/TACC-Docs/blob/main/PUBLISHING.md). | ||
|
||
## Testing | ||
|
||
Testing is manual and requires using a command prompt. You can test [via Python](./TESTING.md#a-via-python) or [via Docker](./TESTING.md#b-via-docker). | ||
|
||
## 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)). | ||
|
||
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 [offer our customization properly](https://github.com/TACC/TACC-Docs/issues/76). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,15 @@ | ||
# TACC Docs | ||
|
||
Built with [MkDocs](https://mkdocs.readthedocs.io/) and a **customized** [ReadTheDocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) theme. | ||
TACC's system documentation at [docs.tacc.utexas.edu](https://docs.tacc.utexas.edu). | ||
|
||
## Contributing | ||
|
||
We welcome contributions, offer a guide for those new to GitHub, and a style guide to simplify reviews. [Read more](./CONTRIBUTING.md). | ||
|
||
## Testing | ||
|
||
Testing is manual and requires using a command prompt. You can test [via Python](./TESTING.md#a-via-python) or [via Docker](./TESTING.md#b-via-docker). | ||
|
||
## Publishing | ||
|
||
We automatically publish `main` branch commits. We manually release versions of TACC-Docs. [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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters