Skip to content

docs: fix inaccurate table names, links, and claims in the user guide - #2770

Merged
killme2008 merged 4 commits into
mainfrom
docs/fix-user-guide-inaccuracies
Aug 21, 2026
Merged

docs: fix inaccurate table names, links, and claims in the user guide#2770
killme2008 merged 4 commits into
mainfrom
docs/fix-user-guide-inaccuracies

Conversation

@killme2008

@killme2008 killme2008 commented Aug 18, 2026

Copy link
Copy Markdown
Member

What changed

Five factual problems found while doing the prose pass in #2768, kept separate
so the wording diff there stayed reviewable.

  1. flow-computation/overview.md named the wrong source table. The prose
    said nginx_access_log in two places, while the CREATE TABLE, the
    CREATE FLOW, the INSERT, and every reference after it use
    ngx_http_log. Following the page as written creates a flow over a table
    that does not exist. The Chinese page had the same mistake in four places.

  2. deployments-administration/overview.md linked "Metadata Storage" to the
    wrong page.
    It pointed at ./manage-data/overview.md, which is data
    management and is already the target of the "Data Management" bullet three
    lines below. Now points at ./manage-metadata/overview.md. The link checker
    passed before this fix because the old target exists — it was the wrong
    page, not a dead one.

  3. use-custom-pipelines.md described a vrl behavior the example does not
    have.
    The text said the processor sets table options "such as adding a
    suffix to the table name and setting the TTL", but the example only sets
    .greptime_ttl. The sentence now describes what this example does.
    greptime_table_suffix and the rest of the options stay documented in
    Write Log API, which the page
    already links at the end.

  4. back-up-&-restore-data.md reused export headings under Import
    Operations.
    Full Databases Backup, Specific Database Backup, and
    Schema-Only Operations each appeared twice, so the import ones published
    as #full-databases-backup-1, #specific-database-backup-1, and
    #schema-only-operations-1. The import headings are renamed to
    Full Databases Import, Specific Database Import, and
    Schema-Only Import, with AnchorAlias preserving all three published
    fragments. The Chinese page had the first two (完整数据库备份-1,
    指定数据库备份-1) and already used distinct headings for the schema-only
    pair. Nothing in the repository links to these fragments, but they are
    published URLs.

  5. deploy-on-kubernetes/overview.md stated Remote WAL as a guarantee.
    "persistently record every data modification and ensure no loss of
    memory-cached data" is the same class of claim docs: replace unconditional guarantees with their actual conditions #2767 addresses. Now states
    the mechanism: writes a Datanode has not yet flushed can be replayed from
    Kafka after a failure. The Kafka retention conditions that govern whether
    replay is possible are covered on the Remote WAL pages by docs: split Kafka deployment and Remote WAL guidance #2762.

Scope

  • Documentation versions: Nightly, 1.2, 1.1
  • Languages: English, Chinese

Verification

  • Rebased onto main after docs: tighten prose in user guide pages flagged by the writing audit #2768 merged; no conflicts.
  • Compared the nightly hunks against the 1.1 and 1.2 copies for every changed
    file: identical, so no hunk context overwrote version-specific text.
  • DOC_LANG=en pnpm check:links — pass
  • DOC_LANG=zh pnpm check:links — pass
  • Inspected the built HTML for the renamed page. English renders
    full-databases-backup-1, specific-database-backup-1 and
    schema-only-operations-1 alongside the new import anchors; Chinese renders
    完整数据库备份-1 and 指定数据库备份-1 alongside 完整数据库导入 and
    指定数据库导入. All published fragments still resolve.
  • git diff --check — clean

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.
  • I updated navigation when the document structure changed.

@cloudflare-workers-and-pages

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

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 81529b1
Status:⚡️  Build in progress...

View logs

@killme2008
killme2008 force-pushed the docs/fix-user-guide-inaccuracies branch from f3af1fa to c4b0bf1 Compare August 18, 2026 14:24
@killme2008
killme2008 requested a lite review from Copilot August 21, 2026 06:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR corrects several factual/documentation accuracy issues in the user guide across Nightly + v1.2 + v1.1 and across English + Chinese, to prevent readers from following broken examples or landing on incorrect pages/anchors.

Changes:

  • Fix the Flow Computation quick start to consistently reference the correct source table name (ngx_http_log) in EN/ZH.
  • Correct the “Metadata Storage” link target to the metadata management page (instead of data management) in EN/ZH.
  • Remove misleading claims by tightening wording: VRL example description now matches what the sample actually does, Remote WAL text no longer implies unconditional guarantees, and duplicate import headings are renamed with published anchor compatibility preserved via AnchorAlias.

Reviewed changes

Copilot reviewed 30 out of 30 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/user-guide/logs/use-custom-pipelines.md Align VRL/table-options prose with the example (.greptime_ttl).
docs/user-guide/flow-computation/overview.md Fix incorrect source table name in the quick start narrative.
docs/user-guide/deployments-administration/overview.md Point “Metadata Storage” to the metadata guide (correct target).
docs/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md Rename duplicate import headings and preserve old fragments with AnchorAlias.
docs/user-guide/deployments-administration/deploy-on-kubernetes/overview.md Replace unconditional Remote WAL guarantee wording with a mechanism-based description.
versioned_docs/version-1.2/user-guide/logs/use-custom-pipelines.md Backport: align VRL/table-options prose with the example (.greptime_ttl).
versioned_docs/version-1.2/user-guide/flow-computation/overview.md Backport: fix incorrect source table name in the quick start narrative.
versioned_docs/version-1.2/user-guide/deployments-administration/overview.md Backport: correct “Metadata Storage” link target.
versioned_docs/version-1.2/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md Backport: rename duplicate import headings and preserve old fragments with AnchorAlias.
versioned_docs/version-1.2/user-guide/deployments-administration/deploy-on-kubernetes/overview.md Backport: update Remote WAL bullet wording to avoid unconditional guarantees.
versioned_docs/version-1.1/user-guide/logs/use-custom-pipelines.md Backport: align VRL/table-options prose with the example (.greptime_ttl).
versioned_docs/version-1.1/user-guide/flow-computation/overview.md Backport: fix incorrect source table name in the quick start narrative.
versioned_docs/version-1.1/user-guide/deployments-administration/overview.md Backport: correct “Metadata Storage” link target.
versioned_docs/version-1.1/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md Backport: rename duplicate import headings and preserve old fragments with AnchorAlias.
versioned_docs/version-1.1/user-guide/deployments-administration/deploy-on-kubernetes/overview.md Backport: update Remote WAL bullet wording to avoid unconditional guarantees.
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/logs/use-custom-pipelines.md 同步修正:表选项描述与示例(.greptime_ttl)一致。
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/flow-computation/overview.md 同步修正:快速入门示例的 source 表名改为 ngx_http_log
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/overview.md 同步修正:“元数据存储”链接指向正确的元数据页面。
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md 同步修正:导入小节标题去重并用 AnchorAlias 保留旧锚点。
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/overview.md 同步修正:Remote WAL 描述改为机制说明,避免无条件保证。
i18n/zh/docusaurus-plugin-content-docs/version-1.2/user-guide/logs/use-custom-pipelines.md 同步回填:表选项描述与示例(.greptime_ttl)一致。
i18n/zh/docusaurus-plugin-content-docs/version-1.2/user-guide/flow-computation/overview.md 同步回填:快速入门示例的 source 表名改为 ngx_http_log
i18n/zh/docusaurus-plugin-content-docs/version-1.2/user-guide/deployments-administration/overview.md 同步回填:“元数据存储”链接指向正确的元数据页面。
i18n/zh/docusaurus-plugin-content-docs/version-1.2/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md 同步回填:导入小节标题去重并用 AnchorAlias 保留旧锚点。
i18n/zh/docusaurus-plugin-content-docs/version-1.2/user-guide/deployments-administration/deploy-on-kubernetes/overview.md 同步回填:Remote WAL 描述改为机制说明,避免无条件保证。
i18n/zh/docusaurus-plugin-content-docs/version-1.1/user-guide/logs/use-custom-pipelines.md 同步回填:表选项描述与示例(.greptime_ttl)一致。
i18n/zh/docusaurus-plugin-content-docs/version-1.1/user-guide/flow-computation/overview.md 同步回填:快速入门示例的 source 表名改为 ngx_http_log
i18n/zh/docusaurus-plugin-content-docs/version-1.1/user-guide/deployments-administration/overview.md 同步回填:“元数据存储”链接指向正确的元数据页面。
i18n/zh/docusaurus-plugin-content-docs/version-1.1/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md 同步回填:导入小节标题去重并用 AnchorAlias 保留旧锚点。
i18n/zh/docusaurus-plugin-content-docs/version-1.1/user-guide/deployments-administration/deploy-on-kubernetes/overview.md 同步回填:Remote WAL 描述改为机制说明,避免无条件保证。

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Base automatically changed from docs/tighten-user-guide-prose to main August 21, 2026 06:51
- flow-computation/overview.md named the source table nginx_access_log
  while the DDL and every query use ngx_http_log
- deployments-administration/overview.md linked Metadata Storage to the
  data management page instead of manage-metadata
- use-custom-pipelines.md described the vrl processor as adding a table
  name suffix, which the example does not do
- back-up-&-restore-data.md reused the export headings under Import
  Operations; renamed with AnchorAlias for the published anchors
- deploy-on-kubernetes/overview.md described Remote WAL as ensuring no
  loss of memory-cached data
…rations

"Schema-Only Operations" appeared under both Export Operations and Import
Operations, so the import one published as #schema-only-operations-1.
AnchorAlias keeps that fragment. The Chinese page already uses distinct
headings here.
@killme2008
killme2008 force-pushed the docs/fix-user-guide-inaccuracies branch from c4b0bf1 to 83c2d2c Compare August 21, 2026 07:01
@killme2008
killme2008 requested a review from sunng87 August 21, 2026 07:03
@sunng87

sunng87 commented Aug 21, 2026

Copy link
Copy Markdown
Member

backport! 1.2

@github-actions

Copy link
Copy Markdown
Contributor

ℹ️ Backport command executed for version 1.2, but no changes were detected.

This might mean:

  • No changes needed to be backported
  • The backport command didn't produce any modifications

…t example

"The same applies to import tool" pointed at the export block it used to
duplicate. Every other example on the page names what it does, and the
Chinese page already reads "导入指定数据库".
@killme2008
killme2008 merged commit 0349bce into main Aug 21, 2026
6 of 7 checks passed
@killme2008
killme2008 deleted the docs/fix-user-guide-inaccuracies branch August 21, 2026 07:44
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.

4 participants