https://github.com/charmed-hpc/docs
Charmed HPC's documentation 📑🔍
https://github.com/charmed-hpc/docs
documentation hpc sphinx
Last synced: 4 months ago
JSON representation
Charmed HPC's documentation 📑🔍
- Host: GitHub
- URL: https://github.com/charmed-hpc/docs
- Owner: charmed-hpc
- License: cc-by-sa-4.0
- Created: 2024-06-14T18:01:24.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-29T17:49:23.000Z (5 months ago)
- Last Synced: 2026-01-30T05:11:00.252Z (5 months ago)
- Topics: documentation, hpc, sphinx
- Language: Python
- Homepage: https://documentation.ubuntu.com/charmed-hpc
- Size: 787 KB
- Stars: 2
- Watchers: 4
- Forks: 8
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Charmed HPC documentation
[](https://documentation.ubuntu.com/charmed-hpc/latest/)
[](https://matrix.to/#/#hpc:ubuntu.com)
Charmed HPC's documentation 📑🔍
For more information on how to access or contribute to Charmed HPC's
documentation, check out the [Getting Started](#-getting-started) and
[Development](#️-development) sections below.
## ✨ Getting started
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](https://matrix.to/#/#hpc:ubuntu.com) 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](./CONTRIBUTING.md) file.
## 🛠️ Development
To start the development server locally and render a preview, follow step one from the [Pull Request](./CONTRIBUTING.md#pull-requests-and-contributing-process) section of the [CONTRIBUTING](./CONTRIBUTING.md) file and then run the following command in your terminal:
```shell
$ make run
```
and 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](./CONTRIBUTING.md) 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](https://ubuntu.com/community/governance/teams/hpc) community. Interested in contributing new documentation, improving existing pages, or reviewing tutorials and how-tos? Great! Here's
some links to help you get started:
* [Ubuntu Code of Conduct](https://ubuntu.com/community/ethos/code-of-conduct)
* [Contributing guidelines](./CONTRIBUTING.md)
* [Join the conversation on Matrix](https://matrix.to/#/#hpc:ubuntu.com)
* [Get the latest news on Discourse](https://discourse.ubuntu.com/c/hpc/151)
* [Ask and answer questions on GitHub](https://github.com/orgs/charmed-hpc/discussions/categories/q-a)
## 📋 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](./LICENSE) file for further details.