docs: add operator documentation template and architecture overview#28
Closed
whg517 wants to merge 2 commits into
Closed
docs: add operator documentation template and architecture overview#28whg517 wants to merge 2 commits into
whg517 wants to merge 2 commits into
Conversation
- DOC-001: Add docs/operators/_template.md with standardized sections (Overview, Prerequisites, Quick Start, Configuration, Advanced, Troubleshooting) - DOC-002: Add docs/architecture.md with platform architecture, operator-go framework, built-in operators, component dependencies, and data flow examples - Add architecture.md to Quick Start sidebar
3 tasks
whg517
force-pushed
the
docs/operator-template-and-architecture
branch
2 times, most recently
from
a60901e to
42768dc
Compare
Member
Author
|
Superseded by #30 which includes the same architecture and template content but based on main branch and with OLM references removed. |
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
1 participant
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.
Summary
docs/operators/_template.md— standardized template for all Operator documentation with sections: Overview, Prerequisites, Quick Start (Install/Deploy/Verify), Configuration (Roles/Configurations/Listeners/Dependencies), Advanced (Resources/Placement/Security/Logging), Troubleshooting, Clean Up, Related Linksdocs/architecture.md— platform architecture overview including Mermaid diagrams for platform layers, operator-go CRD abstraction, built-in operators, component dependency graph, and data flow example (Trino → Hive → HDFS)Changes
docs/operators/_template.md(new) — Operator doc template (underscore prefix = excluded from build)docs/architecture.md(new) — Architecture overviewsidebars.ts— Added architecture linkTesting
npm run buildpasses for both en and zh-Hans locales_template.mdcorrectly excluded from build output (Docusaurus underscore convention)