Writing Docs

How to write and maintain User and Sysadmin docs

Hugo

The HPC Group uses Hugo to generate its website. Hugo is a static site generator that transforms Markdown documents into web pages. For more information on how to organize content see the docs.

Docsy is the Hugo theme used to display our pages. Docsy is designed for technical documentation and handles things like the chapter links in the sidebar. More info on docsy.

Making changes

The first step to make changes to the site is to clone the site’s github repo.

git clone https://github.com/Morehouse-HPC/HPC-docs

This gets you a local copy of the documentation. You’ll also want to install Hugo on your machine to be able to see the local version of the site. Here are some instructions on installing Hugo on a variety of platforms.

Once it’s installed run you can run hugo server from the project directory, navigate to localhost:1313 in your web broswer, and see changes live.

Once you’re done commit your changes and git push the repository.