https://github.com/xcat2/confluent-docs
Documentation material for confluent
https://github.com/xcat2/confluent-docs
administration cluster deployment hpc provisioning stateless
Last synced: 2 months ago
JSON representation
Documentation material for confluent
- Host: GitHub
- URL: https://github.com/xcat2/confluent-docs
- Owner: xcat2
- License: apache-2.0
- Created: 2025-05-20T17:33:05.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-12-11T15:11:13.000Z (4 months ago)
- Last Synced: 2025-12-12T18:05:20.463Z (4 months ago)
- Topics: administration, cluster, deployment, hpc, provisioning, stateless
- Language: Python
- Homepage: https://xcat2.github.io/confluent-docs/
- Size: 22 MB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Confluent documentation
[](https://github.com/xcat2/confluent-docs/actions) [](https://github.com/xcat2/confluent-docs/blob/master/LICENSE)
The [confluent documentation](https://xcat2.github.io/confluent-docs/) is built using [MkDocs](https://www.mkdocs.org/). All **Markdown** files in the `docs` directory are automatically added to the documentation.
Navigation can be customized using `.nav.yml` files located in each directory.
Since Markdown is supported by most Git web hosting platforms, you can also view or edit the documentation online without using MkDocs.
## Prerequisites
To generate the documentation you need the Python package [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) along with some additional plugins. To install the required dependencies, run:
```bash
pip3 install -r requirements.txt --user
```
Alternatively, you can install these within a Python virtual environment.
Furthermore, you should have the [confluent repository](https://github.com/xcat2/confluent) cloned to `../confluent`.
## Viewing and editing live documentation
For development purposes, you can use the following command to start a local web server that watches the files in the `docs` directory and updates the documentation on changes:
```bash
mkdocs serve
```
Then, access the live documentation at: [http://127.0.0.1:8000](http://127.0.0.1:8000)
## Building HTML documentation
To build static HTML pages, use either:
```bash
./makeattribdoc # generate node_attributes.md from ../confluent
./makeman # generate man pages from ../confluent
mkdocs build # build HTML pages
```
or
```bash
make all
```
The generated HTML pages will be placed in the `_site` directory. You can copy this directory to a web server or open it directly in a web browser.