Skip to content

charmed-hpc/docs

Repository files navigation

Charmed HPC documentation

Documentation Status Matrix

Charmed HPC's documentation πŸ“‘πŸ”

For more information on how to access or contribute to Charmed HPC's documentation, check out the Getting Started and Development sections below πŸ‘‡

✨ Getting started

🚧 WIP 🚧

πŸ› οΈ Development

Use the following command to start the development server and see your documentation changes render in real time:

$ make run

Once you have the development server running on your machine, see the CONTRIBUTING file for how to contribute your changes to Charmed HPC's documentation.

🀝 Project and community

Charmed HPC's documentation is a project of the Ubuntu High-Performance Computing community. Interested in contributing new documentation, improving existing pages, or reviewing tutorials and howtos? Great! Here's some links to help you get started:

πŸ“‹ License

The Charmed HPC documentation is licensed under the Creative Commons Attribution-Share Alike International license, version 4.0. Please see the CC-BY-SA LICENSE file for further details.