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.
Periodically, issues within the docs repository will be labeled as good first issue. These issues are ideally the first place to get started helping with Charmed HPC's documentation. If there are currently no issues labeled good first issue, or none of the issues fit your interest, feel free to reach out on Matrix and ask if the team has any suggestions. Otherwise, small pull requests for grammar and formatting are always a good place to start.
To provide bug reports or enhancement requests regarding the documentation, please see the corresponding sections in the CONTRIBUTING file.
To start the development server locally and render a preview, follow step one from the [Pull Request] section(./CONTRIBUTING.md#pull-requests) of the CONTRIBUTING file and then run the following command in your terminal:
$ make runand open a web page to http://127.0.0.1:8000/ to view the rendered preview.
Once you have the development server running on your machine, see the other sections of the CONTRIBUTING file for how to contribute your changes to Charmed HPC's documentation.
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:
- Ubuntu Code of Conduct
- Contributing guidelines
- Join the conversation on Matrix
- Get the latest news on Discourse
- Ask and answer questions on GitHub
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.