Skip to content

Extended the Architecture section#387

Open
nastena1606 wants to merge 5 commits into2.0from
Improve-architecture-doc
Open

Extended the Architecture section#387
nastena1606 wants to merge 5 commits into2.0from
Improve-architecture-doc

Conversation

@nastena1606
Copy link
Copy Markdown
Collaborator

No description provided.

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 expands and reorganizes the documentation “Architecture” content by adding new Operator overview pages, updating MkDocs navigation to surface them, and introducing tooling to generate/update an Operator workflow diagram.

Changes:

  • Add new conceptual docs pages (“Kubernetes Operator concepts”, “How the Operator works”, “Features and capabilities”) and wire them into the MkDocs nav.
  • Rewrite/extend docs/architecture.md with more detailed component and workflow explanations.
  • Add a diagram-generation script (and dependency) for an Operator control-flow diagram, plus minor doc/link wording tweaks.

Reviewed changes

Copilot reviewed 8 out of 12 changed files in this pull request and generated 10 comments.

Show a summary per file
File Description
requirements.txt Adds diagrams dependency to support diagram generation tooling.
mkdocs-base.yml Reworks navigation under “Understand the Operator” and links new pages.
docs/scaling.md Minor wording/punctuation tweak when referencing Architecture.
docs/operator-how-it-works.md New page describing reconciliation/CRDs and linking to architecture/features.
docs/operator-concepts.md New conceptual overview page with embedded workflow diagram.
docs/features.md New feature/capabilities overview page with links into the doc set.
docs/assets/fragments/what-you-install.txt Minor wording tweak for the Architecture reference.
docs/assets/diagrams/operator_flow.py Adds a script to generate/update the operator workflow diagram.
docs/architecture.md Renames and significantly expands Architecture content and structure.
docs/assets/.DS_Store Adds a macOS metadata file (should not be committed).
.gitignore Attempts to ignore .DS_Store files (currently with a pattern bug due to trailing spaces).

Comment on lines 27 to +28
* LLVM (for JIT compilation).
* PMM Client for observability
Copy link

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

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

This component list has inconsistent punctuation/formatting (e.g., “LLVM (for JIT compilation).” followed immediately by “PMM Client for observability” without a period). Make the bullets consistent (capitalization and ending punctuation) to improve readability.

Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@it-percona it-percona temporarily deployed to Improve-architecture-doc - percona-postgresql-operator-2.0 PR #387 March 26, 2026 12:32 — with Render Destroyed
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@it-percona it-percona temporarily deployed to Improve-architecture-doc - percona-postgresql-operator-2.0 PR #387 March 26, 2026 12:32 — with Render Destroyed
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.

4 participants