AB-449 Polish the README.md and add new docs#6
Conversation
AB-449 PostgreSQL Operator
Based on the research and PoC done in the ticket and PR https://github.com/aboutbits/minio-operator/pull/1 We most likely will use CloudNativePG AB-396 for the DB Setup and this operator to manage the access, e.g. PostgreSQL roles and grants. The scope of the operator is:
|
There was a problem hiding this comment.
Pull request overview
This PR polishes the README.md and adds comprehensive documentation for the PostgreSQL Operator's Custom Resource Definitions (CRDs). The changes improve the operator's usability by providing clear documentation and usage examples.
Changes:
- Restructured README.md with improved organization, usage examples, and contribution guidelines
- Added individual documentation files for each CRD (ClusterConnection, Database, Schema, Role, Grant, DefaultPrivilege)
- Moved Docker environment setup instructions to a separate documentation file
- Updated .editorconfig to specify indent size for markdown files
Reviewed changes
Copilot reviewed 9 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Restructured with usage examples, CRD links, and reorganized contribution/build sections |
| docs/cluster-connection.md | Added documentation for ClusterConnection CRD with examples and field descriptions |
| docs/database.md | Added documentation for Database CRD with reclaim policy details |
| docs/schema.md | Added documentation for Schema CRD with field specifications |
| docs/role.md | Added documentation for Role CRD including flags, login/no-login roles, and examples |
| docs/grant.md | Added documentation for Grant CRD with object types and privilege lists |
| docs/default-privilege.md | Added documentation for DefaultPrivilege CRD with usage examples |
| docs/docker-environment.md | Moved Docker environment setup instructions from README to dedicated file |
| .editorconfig | Added indent_size specification for markdown files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 13 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 13 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
See
https://github.com/aboutbits/postgresql-operator/blob/ab-449-polish-readme-and-docs/README.md
https://github.com/aboutbits/postgresql-operator/blob/ab-449-polish-readme-and-docs/docs/cluster-connection.md
https://github.com/aboutbits/postgresql-operator/blob/ab-449-polish-readme-and-docs/docs/database.md
https://github.com/aboutbits/postgresql-operator/blob/ab-449-polish-readme-and-docs/docs/schema.md
https://github.com/aboutbits/postgresql-operator/blob/ab-449-polish-readme-and-docs/docs/role.md
https://github.com/aboutbits/postgresql-operator/blob/ab-449-polish-readme-and-docs/docs/grant.md
https://github.com/aboutbits/postgresql-operator/blob/ab-449-polish-readme-and-docs/docs/default-privilege.md
https://github.com/aboutbits/postgresql-operator/blob/ab-449-polish-readme-and-docs/docs/docker-environment.md