docs: add architecture overview and operator documentation template#31
Merged
Merged
Conversation
- Add docs/architecture.md with platform architecture, operator-go framework, built-in operators, component dependencies, design principles, and data flow - Add docs/operators/_template.md with standardized Operator doc template (Helm-based installation, no OLM references) - Update sidebars.ts to include architecture in Quick Start section
whg517
force-pushed
the
docs/architecture-and-template
branch
from
a1c7e2f to
52a71b9
Compare
Translate all remaining English sections including placeholder hints, blockquotes, and link labels
There was a problem hiding this comment.
Pull request overview
Adds foundational documentation to help users and contributors understand Kubedoop’s platform architecture and standardize Operator documentation, plus exposes the new architecture page in the docs navigation.
Changes:
- Added a new Architecture overview page with Mermaid diagrams and a Trino→Hive→HDFS data flow example.
- Added standardized Operator documentation templates for both English and zh-Hans locales.
- Updated
sidebars.tsto link the new Architecture page from the “Quick Start” section.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| sidebars.ts | Adds architecture to the “Quick Start” sidebar category so the new page is discoverable. |
| docs/architecture.md | New architecture overview describing platform layers, operator-go concepts, built-in Operators, dependencies, and a data-flow sequence. |
| docs/operators/_template.md | New English Operator doc template (Helm-based installation flow, standard sections, internal cross-links). |
| i18n/zh/docusaurus-plugin-content-docs/current/operators/_template.md | New zh-Hans version of the Operator doc template mirroring the English structure and links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Kubernetes {version}+ | ||
| - kubectl {version}+ | ||
| - {Other dependencies — e.g., if this component depends on HDFS, list HDFS Operator here} | ||
| - Helm v3+ installed — see [Quick Start](../quick-start/installation.md) |
| Delete the {Component} cluster: | ||
|
|
||
| ```bash | ||
| kubectl delete {clusterkind} {cluster-name} -n {operator-name} |
| - **Cause**: {Why this happens} | ||
| - **Resolution**: {Steps to fix} | ||
|
|
||
| > For common issues across all Operators, see [Troubleshooting](../troubleshooting). |
| - Kubernetes {version}+ | ||
| - kubectl {version}+ | ||
| - {其他依赖 — 例如：如果该组件依赖 HDFS，在此列出 HDFS Operator} | ||
| - Helm v3+ 已安装 — 参见 [快速开始](../quick-start/installation.md) |
| 检查集群状态： | ||
|
|
||
| ```bash | ||
| kubectl get {clusterkind} -n {operator-name} |
| 删除 {Component} 集群： | ||
|
|
||
| ```bash | ||
| kubectl delete {clusterkind} {cluster-name} -n {operator-name} |
| - **原因**：{为什么会发生} | ||
| - **解决方案**：{修复步骤} | ||
|
|
||
| > 所有 Operator 的通用问题请参阅 [故障排查](../troubleshooting)。 |
Comment on lines
+8
to
+9
| through a unified Operator framework. The platform uses Helm charts | ||
| for Operator installation and lifecycle management, running entirely on top of Kubernetes. |
| Check the cluster status: | ||
|
|
||
| ```bash | ||
| kubectl get {clusterkind} -n {operator-name} |
2 tasks
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.
Summary
Changes
docs/architecture.md(new) — Platform architecture, operator-go framework,built-in operators, component dependencies, design principles, data flow example
docs/operators/_template.md(new) — Standardized template for Operator docs(Overview, Prerequisites, Quick Start, Configuration, Advanced, Troubleshooting)
sidebars.ts— Added architecture link in Quick Start sectionTesting
npm run buildpasses for both en and zh-Hans locales