This is the main repository for CCR's research computing documentation.
Find an error? Feel free to submit an issue.
Contributions and Pull Requests (PRs) welcome! Follow the instructions below to learn how to develop and make changes to the documentation source.
-
Clone your fork:
$ git clone https://github.com/YOURUSER/ccrdocs.git
$ cd ccrdocs
- Create a python3 virtual environment and install dependencies:
$ python3 -mvenv venv
$ source venv/bin/activate
$ pip install --upgrade pip
$ pip install -r requirements.txt
- Run mkdocs development server:
$ mkdocs serve
-
Point your browser at: http://localhost:8000
-
Start hacking on the markdown in the
pages/directory -
Submit a Pull Request (PR)
-
Try to keep content organized in respective directories under
pages/ -
Remember to add any new pages to the nav config in
mkdocs.yml -
Documentation is written in Markdown syntax
-
Add notes (note, warning, danger, important) to your documentation leveraging the Markdown Admonition extension
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License