docs: correct outdated Nightly contributor guide content - #2784
Conversation
Deploying greptime-docs with
|
| Latest commit: |
e499e61
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://00896b6c.greptime-docs.pages.dev |
| Branch Preview URL: | https://codex-audit-contributor-guid.greptime-docs.pages.dev |
ca9f14d to
1be0a8f
Compare
WenyXu
left a comment
There was a problem hiding this comment.
These comments clarify two Metasrv contracts that contributors must preserve: cache-invalidation fan-out and the separation between lease renewal and Region failure detection.
|
One item is deliberately left out of this PR: |
54bbf18 to
bc05f67
Compare
.mcp.json must stay at the repository root for the MCP client to read it, and it holds connection credentials, so ignore it rather than relocate it.
f3c6e74 to
ca0cd4e
Compare
Collapse the legacy TimeSeriesMemtable and SimpleBulkMemtable into one paragraph instead of giving them a selection-table row each and their own section. They remain reachable for regions on the legacy primary_key SST format, so the page still names them, but the bulk and flat path is now clearly the subject.
Apply the Nightly contributor-guide rewrite to the three supported released versions, and gate each version-sensitive claim on what that release ships. v1.2 (GreptimeDB v1.2.0-beta.2) takes the change unchanged. v1.1 (v1.1.4) drops the compatibility-test entry, because tests/compatibility and 'cargo sqlness compat' arrived after that release, and drops x-greptime-err-retry-hint, which v1.1 does not send. v1.0 (v1.0.2) additionally omits the new Memtable page: MemtableOptions there still has a PartitionTree variant, so the page's selection rules and its statement that partition_tree is not a third implementation do not hold. The links to that page degrade to plain text. It also drops the pending-batching-flow sentence, since defer_on_missing_source does not exist yet, and keeps its own existing wording where the rewrite did not change meaning. reference/sql/create.md and the Mito memtable configuration section change only in v1.1 and v1.2. v1.0.2 still has MitoConfig::memtable and accepts memtable.type=partition_tree, so the original text is correct there. Also fix the blog link domain on the new Memtable page: Chinese pages use greptime.cn and English pages use greptime.com without the www prefix, matching the existing link to the same article in features-that-you-concern.md.
What changed
Correct and complete the Nightly contributor guide while keeping it focused on component contracts, main execution paths, and contributor decisions rather than source navigation.
The architecture and testing boundary follows established contributor documentation practice: explain abstractions, flows, invariants, and how to validate a change; leave implementation-level exploration to the source. No source directory or file-path navigation is added to the architecture pages.
Scope
GreptimeDB release actually ships:
tests/compatibilityandcargo sqlness compatlanded after that release) and
x-greptime-err-retry-hint(not sent by v1.1).MemtableOptionsthere still has aPartitionTreevariant, so the page's selection rules do not hold; links to it degrade to plain text.It also drops the pending-batching-flow sentence (
defer_on_missing_sourcedoes not exist yet).reference/sql/create.mdand the Mito memtable configuration section change only in v1.1 and v1.2.v1.0.2 still has
MitoConfig::memtableand acceptsmemtable.type=partition_tree, so the originaltext is correct there.
Verification
DOC_LANG=en pnpm check:linksDOC_LANG=zh pnpm check:linkstyposon all modified Markdown filesgit diff --check0cc83c4570, the currentgreptime-protodefinitions, and tags
v1.0.2,v1.1.4, andv1.2.0-beta.2for the backported versions.main; no released/0.x docs, generated outputs, or lockfiles changed. Two user-guide edits are intentional and in scope:user-guide/deployments-administration/configuration.mddrops the removed[region_engine.mito.memtable]section, andreference/sql/create.mdcorrects thememtable.typevalues.Checklist
sidebars.tsadds the new Memtable page. The removed Python Scripts pages needed no navigation change because they were already excluded from the build.