Skip to content

docs: refresh observability concepts foundation - #2740

Merged
killme2008 merged 4 commits into
mainfrom
codex/refresh-concepts-foundation
Aug 13, 2026
Merged

docs: refresh observability concepts foundation#2740
killme2008 merged 4 commits into
mainfrom
codex/refresh-concepts-foundation

Conversation

@killme2008

@killme2008 killme2008 commented Aug 12, 2026

Copy link
Copy Markdown
Member

What changed

Refresh the Nightly concepts foundation around the questions teams ask when evaluating an observability backend.

  • Rework why-greptimedb.md around operating problems and their corresponding mechanisms instead of presenting an architecture inventory.
  • Explain one columnar engine with separate tables, schemas, indexes, TTLs, and compaction settings for different signal types.
  • Show how real-time monitoring and historical analysis share one system while retaining separate workload controls.
  • State ingestion and query boundaries without implying full compatibility with source systems.
  • Separate open-source capabilities from GreptimeDB Enterprise features.
  • Clarify the time index, Tag/Timestamp/Field roles, merge modes, table engines, storage providers, and recovery responsibilities.
  • Redraw the time-series table model and add localized diagrams for the unified signal model and shared monitoring workloads.
  • Preserve published routes and fragments. Add repository guidance that AnchorAlias protects published fragments, not intermediate headings from an unmerged PR.

Stack

Scope

  • Documentation versions: Nightly only; released versions are unchanged
  • Languages: English and Chinese
  • Repository guidance and CI: narrow updates for AnchorAlias handling and the front-matter exception for AGENTS.md

Verification

  • git diff --check origin/main...HEAD
  • pnpm dlx markdownlint-cli <changed files> --config .markdownlint.yaml
  • pnpm exec typos <changed files>
  • DOC_LANG=en pnpm check:links
  • DOC_LANG=zh pnpm check:links
  • xmllint --noout for the new SVG files
  • Rendered and inspected the English and Chinese diagrams for clipping, overlap, and text alignment
  • Reviewed the complete diff for versioned docs, generated files, and lockfile changes

Both strict link checks completed their production builds successfully.

Checklist

  • I verified the content against the applicable GreptimeDB version.
  • I updated the relevant documentation versions and languages, or explained why not.
  • I checked changed links and anchors.
  • Navigation is unchanged; existing routes remain in place.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 12, 2026

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: ca8d03e
Status: ✅  Deploy successful!
Preview URL: https://dafa9d60.greptime-docs.pages.dev
Branch Preview URL: https://codex-refresh-concepts-found.greptime-docs.pages.dev

View logs

Base automatically changed from codex/clarify-observability-data-model to main August 13, 2026 03:40
@killme2008
killme2008 force-pushed the codex/refresh-concepts-foundation branch from cede11a to ee013b9 Compare August 13, 2026 07:24
@killme2008
killme2008 force-pushed the codex/refresh-concepts-foundation branch from ee013b9 to f87761f Compare August 13, 2026 07:26
@killme2008
killme2008 marked this pull request as ready for review August 13, 2026 07:35
@killme2008
killme2008 requested a review from sunng87 August 13, 2026 07:35
@killme2008
killme2008 merged commit 9bb41ea into main Aug 13, 2026
7 checks passed
@killme2008
killme2008 deleted the codex/refresh-concepts-foundation branch August 13, 2026 08:51
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.

2 participants