This is a Commodore Component for Rook Ceph.
This repository is part of Project Syn. For documentation on Project Syn and this component, see syn.tools.
The rendered documentation for this component is available on the Commodore Components Hub.
Documentation for this component is written using Asciidoc and Antora.
It can be found in the docs folder.
We use the Divio documentation structure to organize our documentation.
Run the make docs-serve command in the root of the project, and then browse to http://localhost:2020 to see a preview of the current state of the documentation.
After writing the documentation, please use the make docs-vale command and correct any warnings raised by the tool.
This library is licensed under BSD-3-Clause. For information about how to contribute, see CONTRIBUTING.