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.

LFX Mentorship 2025/3

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.

Contributing

Contributions are welcome! If you’d like to improve the documentation or help refine the tooling, please follow these steps:

1. Fork this repository and create a new branch for your changes.
2. Make your edits and ensure that all links and references are correct.
3. 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.

Building the Documentation

Website

This website is built using Docusaurus, a modern static website generator.

Installation

Enter the website folder, then run:

Local Development

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

This command generates static content into the build directory and can be served using any static contents hosting service.

Testing Production Features

Some features, like redirects, only work in production builds and are not available during local development (yarn start). To test these features locally:

This builds the site and serves it locally, allowing you to test production-only features.

Deployment

Using SSH:

Not using SSH:

GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Workflow

The documentation is updated from the upstream CloudNativePG project by the sync_docs workflow.

License

This project is licensed under the Apache License 2.0.