docs: correct observability concepts and terminology - #2741
Merged
Conversation
Deploying greptime-docs with
|
| Latest commit: |
f76d9b7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a7dd555c.greptime-docs.pages.dev |
| Branch Preview URL: | https://codex-refresh-concepts-facts.greptime-docs.pages.dev |
killme2008
force-pushed
the
codex/refresh-concepts-foundation
branch
from
August 13, 2026 07:24
cede11a to
ee013b9
Compare
killme2008
force-pushed
the
codex/refresh-concepts-facts
branch
from
August 13, 2026 07:24
a2e414c to
ea38b6a
Compare
killme2008
force-pushed
the
codex/refresh-concepts-foundation
branch
from
August 13, 2026 07:26
ee013b9 to
f87761f
Compare
killme2008
force-pushed
the
codex/refresh-concepts-facts
branch
from
August 13, 2026 07:26
ea38b6a to
3390dc3
Compare
4 tasks
killme2008
force-pushed
the
codex/refresh-concepts-facts
branch
2 times, most recently
from
August 13, 2026 08:12
ff72af8 to
b6336ec
Compare
killme2008
force-pushed
the
codex/refresh-concepts-facts
branch
from
August 13, 2026 08:53
b6336ec to
2fb1fe2
Compare
killme2008
marked this pull request as ready for review
August 14, 2026 04:16
killme2008
requested review from
sunng87 and
v0y4g3r
and
a lite review from Copilot
August 14, 2026 04:16
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Nightly (EN+ZH) documentation to correct and align observability-related concepts and terminology (Pipeline/Flow, table engines, Regions, storage/recovery responsibilities), and refreshes supporting architecture/flow diagrams to match the clarified boundaries.
Changes:
- Reframes Observability 2.0 as an optional wide-event practice and moves “shared observability table model” framing into the Data Model pages (EN+ZH), with consistent definitions across Concepts/Glossary/FAQ.
- Replaces/updates multiple SVG diagrams (EN+ZH) to reflect distributed vs standalone paths, object storage scope, and responsibilities (WAL vs persistent files vs Metasrv state).
- Renames the Concepts sidebar entry label for the Observability 2.0 page (URL unchanged) and updates the corresponding ZH i18n sidebar label.
Reviewed changes
Copilot reviewed 29 out of 35 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| static/shared-system-realtime-historical.zh.svg | Updates diagram text/description to scope the “shared system” story to distributed + object storage and clarify Enterprise isolation. |
| static/shared-system-realtime-historical.svg | Same as above for English. |
| static/optional-pipeline-flow.zh.svg | Clarifies Flow’s relationship to incoming event rows (continuous aggregation wording). |
| static/optional-pipeline-flow.svg | Same as above for English. |
| static/greptimedb-distributed-architecture.zh.svg | Adds a new distributed architecture diagram (ZH) separating data/control paths and recovery responsibilities. |
| static/greptimedb-distributed-architecture.svg | Adds a new distributed architecture diagram (EN) separating data/control paths and recovery responsibilities. |
| sidebars.ts | Renames the Concepts sidebar label for the Observability 2.0 page (URL unchanged). |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/performance-tuning/design-table.md | Removes TSDB framing in distributed table misconceptions; tightens wording. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/manage-data/basic-table-operations.md | Rewords TIME INDEX explanation to “exactly one time index” without TSDB classification. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/why-greptimedb.md | Aligns “shared system” section with object-storage distributed scope; adjusts diagram usage. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/semantic-layer.md | Clarifies purpose/mechanics of greptime.semantic.* metadata and protocol-specific limits. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/overview.md | Updates deep-dive link label to the new Observability 2.0 wording. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/observability-2.md | Reframes page around wide events as optional practice and Pipeline/SQL/Flow staging. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/key-concepts.md | Redefines core concepts (time index, PK, Region, engines, Pipeline/Flow) consistently. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/features-that-you-concern.md | Updates FAQ answers for update/delete/TTL/high-cardinality/DR/geo/JSON (JSON vs JSON2). |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/data-model.md | Establishes Data Model as the “source of truth” and adds the shared model diagram. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/architecture.md | Replaces high-level image with new diagram; clarifies component roles and request paths. |
| i18n/zh/docusaurus-plugin-content-docs/current/reference/glossary.md | Updates glossary definitions to match revised concepts (engines, Region, WAL, JSON2, etc.). |
| i18n/zh/docusaurus-plugin-content-docs/current/enterprise/overview.md | Repositions Enterprise overview around deployment/security/availability/ops capabilities. |
| i18n/zh/docusaurus-plugin-content-docs/current/contributor-guide/datanode/data-persistence-indexing.md | Tightens inverted-index explanation wording (ZH). |
| i18n/zh/docusaurus-plugin-content-docs/current.json | Updates the ZH sidebar label key/value to match the renamed English label. |
| docs/user-guide/deployments-administration/performance-tuning/design-table.md | Removes TSDB framing in distributed table misconceptions; tightens wording. |
| docs/user-guide/deployments-administration/manage-data/basic-table-operations.md | Rewords TIME INDEX explanation to “exactly one time index” without TSDB classification. |
| docs/user-guide/concepts/why-greptimedb.md | Aligns “shared system” section with object-storage distributed scope; adjusts diagram usage. |
| docs/user-guide/concepts/semantic-layer.md | Clarifies purpose/mechanics of greptime.semantic.* metadata and protocol-specific limits. |
| docs/user-guide/concepts/overview.md | Updates deep-dive link label to the new Observability 2.0 wording. |
| docs/user-guide/concepts/observability-2.md | Reframes page around wide events as optional practice and Pipeline/SQL/Flow staging. |
| docs/user-guide/concepts/key-concepts.md | Redefines core concepts (time index, PK, Region, engines, Pipeline/Flow) consistently. |
| docs/user-guide/concepts/features-that-you-concern.md | Updates FAQ answers for update/delete/TTL/high-cardinality/DR/geo/JSON (JSON vs JSON2). |
| docs/user-guide/concepts/data-model.md | Establishes Data Model as the “source of truth” and adds the shared model diagram. |
| docs/user-guide/concepts/architecture.md | Replaces high-level image with new diagram; clarifies component roles and request paths. |
| docs/reference/glossary.md | Updates glossary definitions to match revised concepts (engines, Region, WAL, JSON2, etc.). |
| docs/getting-started/installation/overview.md | Removes “time series database” wording from cluster install entry. |
| docs/enterprise/overview.md | Repositions Enterprise overview around deployment/security/availability/ops capabilities. |
| docs/contributor-guide/datanode/data-persistence-indexing.md | Tightens inverted-index explanation wording (EN). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
sunng87
approved these changes
Aug 14, 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.
What changed
Correct factual boundaries and terminology across the Nightly concept and reference pages.
Dependency
mainmain.Scope
Verification
git diff --checknpx --yes markdownlint-cli@0.45.0 --config .markdownlint.yaml <changed files>typos --config .typos.toml <changed files>xmllint --noout <changed SVG files>pnpm buildDOC_LANG=zh pnpm buildDOC_LANG=en pnpm check:linksDOC_LANG=zh pnpm check:linksBoth strict link checks and both locale builds completed successfully.
Checklist