https://github.com/cloudnative-pg/docs
CloudNativePG operator documentation project
https://github.com/cloudnative-pg/docs
Last synced: about 2 months ago
JSON representation
CloudNativePG operator documentation project
- Host: GitHub
- URL: https://github.com/cloudnative-pg/docs
- Owner: cloudnative-pg
- License: apache-2.0
- Created: 2025-10-15T11:16:16.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-01-26T21:00:10.000Z (2 months ago)
- Last Synced: 2026-01-27T08:00:40.134Z (2 months ago)
- Language: TypeScript
- Size: 4.62 MB
- Stars: 2
- Watchers: 0
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Governance: GOVERNANCE.md
Awesome Lists containing this project
README
[](https://cloudnative-pg.io/)
# CloudNativePG Documentation
**Chaos Documentation** is the initiative responsible for building and
maintaining the official documentation for
**[CloudNativePG](https://cloudnative-pg.io/)** — 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](https://mentorship.lfx.linuxfoundation.org/project/86a647c1-88c7-474f-b093-6abb58197083)
programme, with **Anushka Saxena** as the mentee.
For more details, see [cloudnative-pg/cloudnative-pg#8122](https://github.com/cloudnative-pg/cloudnative-pg/issues/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](./CODE_OF_CONDUCT.md)
and make sure your work aligns with the project’s values and goals.
---
## Building the Documentation
# Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
## Installation
Enter the `website` folder, then run:
```bash
yarn
```
## Local Development
```bash
yarn start
```
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
```bash
yarn 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:
```bash
yarn build
yarn serve
```
This builds the site and serves it locally, allowing you to test production-only
features.
## Deployment
Using SSH:
```bash
USE_SSH=true yarn deploy
```
Not using SSH:
```bash
GIT_USER= 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](.github/workflows/sync_docs.yml).
---
## License
This project is licensed under the [Apache License 2.0](./LICENSE).