All contributions should be made via a GitHub pull request. The pull requests will be reviewed by TACC's User Services staff, and if approved, incorporated into our documentation.
- Fork this repository.
- Edit relevant files that need update. Upload images as necessary.
- Commit your changes, writing clear commit messages.
- Test your changes if comfortable using a command prompt.
- Request a review. This creates a "Pull Request".
- Use Markdown for your source text.
- Use
cwd-relative paths to images e.g. instead of/hpc/imgs/myimage.png, use../imgs/myimage.pngso that images load on the website and in GitHub preview. - Some Python-Markdown extensions and PyMdown exensions are enabled. See enabled extensions at
mkdocs.base.ymlundermarkdown_extensions:.
Always write a clear log message for your commits. One-line messages are fine for small/typo changes, but more involved edits should include:
A brief summary of the commit A not-so-brief description of what changed and its impact.