Chaos Documentation is the initiative responsible for building and maintaining the official documentation for CloudNativePG — the open-source operator for managing PostgreSQL workloads on Kubernetes from the CNCF.
This repository is part of the LFX Mentorship 2025/3 programme, with Anushka Saxena as the mentee. For more details, see cloudnative-pg/cloudnative-pg#8122.
Contributions are welcome! If you’d like to improve the documentation or help refine the tooling, please follow these steps:
- Fork this repository and create a new branch for your changes.
- Make your edits and ensure that all links and references are correct.
- Submit a pull request with a clear description of what you’ve changed.
Before contributing, please review the Code of Conduct and make sure your work aligns with the project’s values and goals.
This website is built using Docusaurus, a modern static website generator.
yarnyarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn buildThis command generates static content into the build directory and can be
served using any static contents hosting service.
Using SSH:
USE_SSH=true yarn deployNot using SSH:
GIT_USER=<Your GitHub username> yarn deployIf you are using GitHub pages for hosting, this command is a convenient way to
build the website and push to the gh-pages branch.
The documentation is updated from the upstream CloudNativePG project by the
sync_docs workflow.
This project is licensed under the Apache License 2.0.