Skip to content

docs: update Flow user guide - #2799

Merged
discord9 merged 8 commits into
mainfrom
docs/update-flow-user-guide
Sep 8, 2026
Merged

docs: update Flow user guide#2799
discord9 merged 8 commits into
mainfrom
docs/update-flow-user-guide

Conversation

@discord9

@discord9 discord9 commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

What changed

  • Refresh the Flow user guide, clarify batching versus scheduled full-query execution, and correct SQL examples and cleanup commands.
  • Document missing-source deferral and the manual drop/recreate activation workflow, append-only experimental incremental reads, sink schema, and SQL/TQL update_at differences.
  • Present Flow inspection commands and their purposes as tables in English and Chinese.
  • Add the required evaluation interval to the non-windowed quick-start aggregate in all three versions.
  • Backport release-valid guidance to v1.1 and v1.2. Keep their older mode-selection behavior: EVAL INTERVAL does not force batching there, while current Nightly does after feat(flow): support eval schedule offsets greptimedb#8878.
  • Omit SHOW FLOW STATUS and information_schema.flow_statistics from v1.1 because those interfaces are unavailable in v1.1.4.

Source verification: GreptimeDB 27b0ca667634e132a13f29ff268f8b2472295bee for current Nightly behavior, v1.1.4, and v1.2.0-beta.2.

Scope

  • Documentation versions: Nightly, v1.1, v1.2
  • Languages: English, Chinese
  • 24 Flow user-guide pages; no configuration, navigation, lockfile, or generated-file changes relative to the base branch.

Verification

  • git diff --check origin/main...HEAD
  • DOC_LANG=en pnpm check:links (includes production build)
  • DOC_LANG=zh pnpm check:links (includes production build)
  • Source-based independent reviews of Nightly and release-specific behavior
  • EN/ZH inspection-command parity and generated HTML table checks

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. No navigation change was required.

Signed-off-by: discord9 <discord9@163.com>
Comment thread docs/user-guide/flow-computation/manage-flow.md Outdated
Comment thread docs/user-guide/flow-computation/manage-flow.md
Signed-off-by: discord9 <discord9@163.com>
…-guide

Signed-off-by: discord9 <discord9@163.com>
Signed-off-by: discord9 <discord9@163.com>
Signed-off-by: discord9 <discord9@163.com>

@killme2008 killme2008 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Don't forget to backport them into v1.2 and v1.1 if possible.

Comment thread docs/user-guide/flow-computation/manage-flow.md Outdated
Signed-off-by: discord9 <discord9@163.com>
Signed-off-by: discord9 <discord9@163.com>
Signed-off-by: discord9 <discord9@163.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 8, 2026

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 79e5cfd
Status: ✅  Deploy successful!
Preview URL: https://f319b671.greptime-docs.pages.dev
Branch Preview URL: https://docs-update-flow-user-guide.greptime-docs.pages.dev

View logs

@discord9
discord9 merged commit df4ca8b into main Sep 8, 2026
8 checks passed
@discord9
discord9 deleted the docs/update-flow-user-guide branch September 8, 2026 09:11
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.

3 participants