Skip to content

[fix](doc) backport 3 cross-version consistency fixes to 2.1/3.x#3743

Merged
morningman merged 1 commit into
apache:masterfrom
boluor:fix-consistency-2026-05-22
May 23, 2026
Merged

[fix](doc) backport 3 cross-version consistency fixes to 2.1/3.x#3743
morningman merged 1 commit into
apache:masterfrom
boluor:fix-consistency-2026-05-22

Conversation

@boluor
Copy link
Copy Markdown
Contributor

@boluor boluor commented May 23, 2026

Summary

Three small consistency fixes where the correction already landed in current/4.x but never reached 2.1/3.x (or one EN/3.x file).

File Issue Fix
versioned_docs/version-3.x/admin-manual/cluster-management/upgrade.md placeholder clusterId=<a_new_clusterIP, ...> typo (the value assigned to clusterId= should be an ID, not an IP) clusterIPclusterID. Matches the other 7 instances (EN current/4.x/2.1 + all 4 zh).
versioned_docs/version-3.x/admin-manual/data-admin/backup-restore/backup.md Azure example used literal "azure.account_name" = "ak" / "azure.account_key" = "sk" (looks like a stray copy-paste from the S3 ak/sk block) replace with the documented placeholder form "<account_name>" / "<account_key>", matching the <account_name>.blob.core.windows.net placeholder on the line above and the zh 3.x and all current/4.x EN+zh copies of the same example.
versioned_docs/version-{2.1,3.x}/admin-manual/data-admin/backup-restore/restore.md + the same zh-CN 2.1/3.x files SHOW SNAPSHOT result-table border +-----------------+ (17 dashes) is narrower than the 20-char data column → table renders broken widen the rule line to +--------------------+ and trim the over-padded header cells. Same form already used in current/4.x EN and zh.

Test plan

  • Verified against the current/4.x EN+zh versions of the same pages (which already carry the correct form).
  • Dead-link check passes.
  • CI build.

Three small fixes flagged by the cross-version consistency audit — current/4.x
already had the correction; 2.1/3.x and one EN/3.x file missed the back-port.

- upgrade.md (EN 3.x): placeholder `clusterId=<a_new_clusterIP, ...>` should be
  `clusterID` (the value being assigned to `clusterId=`). All other 7 instances
  (EN current/4.x/2.1 and all 4 zh) already use `clusterID`.
- backup-restore/backup.md (EN 3.x): the Azure example used literal credential
  strings `"azure.account_name" = "ak"` / `"azure.account_key" = "sk"` (stray
  copy-paste from the S3 ak/sk credentials block). Replace with the documented
  placeholder form `<account_name>` / `<account_key>`, matching the
  `<account_name>.blob.core.windows.net` placeholder on the line above and the
  zh 3.x and all current/4.x EN+zh versions of the same example.
- backup-restore/restore.md (EN+zh 2.1/3.x): the `SHOW SNAPSHOT` result-table
  border `+-----------------+` (17 dashes) is narrower than the 20-char data
  column, so the table renders broken. Widen to `+--------------------+` and
  trim the over-padded header cells to match — same form already used in
  current/4.x EN and zh.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@morningman morningman merged commit 0c55783 into apache:master May 23, 2026
3 checks passed
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