docs: fix disaster recovery CLI options - #2492
Merged
Merged
Conversation
Signed-off-by: jeremyhi <fengjiachun@gmail.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: be9e054d26
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Deploying greptime-docs with
|
| Latest commit: |
b2f1e8f
|
| Status: | ⚡️ Build in progress... |
WenyXu
approved these changes
May 26, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates GreptimeDB disaster recovery documentation to reflect current CLI option names for S3 credentials in export/backup examples and option reference tables, and also adjusts the disaster recovery overview content (removing standalone-DR references and an in-house BR-tool note) across English and Chinese docs.
Changes:
- Update S3 credential option names in DR backup/restore examples (
--s3-access-key-id,--s3-secret-access-key) and indata exportoption reference tables. - Remove references to the standalone DR solution page from DR overview pages (EN + ZH, current + v1.0).
- Apply the same documentation updates to localized Chinese content and the v1.0 versioned docs.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-1.0/user-guide/deployments-administration/disaster-recovery/overview.md | Removes standalone-DR references and trims BR wording in v1.0 DR overview. |
| versioned_docs/version-1.0/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-meta-data.md | Updates S3 credential option names in v1.0 metadata snapshot examples. |
| versioned_docs/version-1.0/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md | Updates S3 credential option names in v1.0 data export example. |
| versioned_docs/version-1.0/reference/command-lines/utilities/data.md | Updates v1.0 data export option table to new S3 credential flags. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.0/user-guide/deployments-administration/disaster-recovery/overview.md | Mirrors DR overview content removals/adjustments in ZH v1.0. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.0/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-meta-data.md | Updates ZH v1.0 metadata snapshot S3 credential option names. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.0/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md | Updates ZH v1.0 data export example S3 credential option names. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.0/reference/command-lines/utilities/data.md | Updates ZH v1.0 data export option table to new S3 credential flags. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/disaster-recovery/overview.md | Mirrors DR overview content removals/adjustments in ZH current. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-meta-data.md | Updates ZH current metadata snapshot S3 credential option names. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md | Updates ZH current data export example S3 credential option names. |
| i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/data.md | Updates ZH current data export option table to new S3 credential flags. |
| docs/user-guide/deployments-administration/disaster-recovery/overview.md | Removes standalone-DR references and trims BR wording in current EN DR overview. |
| docs/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-meta-data.md | Updates current EN metadata snapshot examples to new S3 credential option names. |
| docs/user-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md | Updates current EN data export example to new S3 credential option names. |
| docs/reference/command-lines/utilities/data.md | Updates current EN data export option table to new S3 credential flags. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
@fengjiachun PTAL |
Signed-off-by: jeremyhi <fengjiachun@gmail.com>
Signed-off-by: jeremyhi <fengjiachun@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What's Changed in this PR
As @copilot said
Checklist
sidebars.tsmatches the current document structure when you changed the document structure.