Unity Cluster User Documentation

User Documentation for Unity Cluster at UMass Amherst

Contributing

1. Install mkdocs: pip install mkdocs
2. Install the theme: pip install mkdocs-material
3. Install a plugin: pip install mkdocs-include-markdown-plugin
4. Navigate to the root of the repository and run mkdocs serve, which will start a web server you can reach from your local browser to test live edits on documentation.

Updating the nodelist/partitionlist Tables

edit the tables here

get the private key into unity-docs/sheets-to-md/unity-sheets-key.json

Install Python modules

pip install gspread
pip install tabulate
pip install oauth2client
pip install pandas

Generate the tables

cd unity-docs/sheets-to-md
./sheets-to-md.py

Upload the new tables back to git