Skip to content

AB-449 Polish the README.md and add new docs#6

Merged
ThoSap merged 7 commits intomainfrom
ab-449-polish-readme-and-docs
Jan 27, 2026
Merged

AB-449 Polish the README.md and add new docs#6
ThoSap merged 7 commits intomainfrom
ab-449-polish-readme-and-docs

Conversation

@ThoSap ThoSap self-assigned this Jan 26, 2026
@linear
Copy link
Copy Markdown

linear bot commented Jan 26, 2026

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:

  • Database/Schema management
  • Role management
  • Grant/Default Privilege management

@ThoSap ThoSap requested a review from Copilot January 26, 2026 12:24
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Base automatically changed from ab-449-postgresql-operator-publish-workflow-and-pg-15-to-18-test-matrix to main January 26, 2026 13:05
@ThoSap ThoSap requested a review from Copilot January 26, 2026 13:35
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@ThoSap ThoSap requested a review from Copilot January 26, 2026 13:50
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

@alexlanz alexlanz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really nice job!

@ThoSap ThoSap removed the request for review from mmalfertheiner January 27, 2026 12:15
@ThoSap ThoSap merged commit e1f7fc9 into main Jan 27, 2026
4 checks passed
@ThoSap ThoSap deleted the ab-449-polish-readme-and-docs branch January 27, 2026 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants