University of Dundee HPC Cluster Documentation

This repository contains the user documentation for the University of Dundee's HPC cluster service. A rendered version is available at:

https://uod-hpc.readthedocs.io

How to Contribute

First fork the repository on Github and clone to your machine. Once the repository is locally on your machine, install MkDocs (assuming Python pip is already installed):

pip install mkdocs

then run:

mkdocs serve

from the repository directory. Navigate to http://127.0.0.1:8000/ in your browser to view the docs.

The browser page will automatically update as you make changes to the documentation files.

Once your changes are complete and your fork updated, open a pull request to have your changes incorporated.