Open
Conversation
There was a problem hiding this comment.
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.mdwith 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 |
There was a problem hiding this comment.
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.
1a5c971 to
2eb8366
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
egegunes
approved these changes
Mar 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.