docs: repair partition columns utility#2333
Conversation
Summary of ChangesHello @MichaelScofield, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the documentation for GreptimeDB's command-line interface utilities. It introduces a new, detailed guide for a utility designed to repair partition column metadata, which is crucial for maintaining data integrity. Additionally, it refines the command syntax for an existing logical table repair utility, ensuring accuracy and consistency in user instructions. These updates aim to provide clearer and more comprehensive resources for users managing their GreptimeDB clusters. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the repair-partition-columns utility and corrects the command syntax for repair-logical-tables. The changes are mostly correct, but I've found a couple of inconsistencies in the Chinese documentation examples where the meta keyword is missing from a command. I've provided suggestions to fix these issues.
...aurus-plugin-content-docs/current/reference/command-lines/utilities/repair-logical-tables.md
Outdated
Show resolved
Hide resolved
...s-plugin-content-docs/version-1.0/reference/command-lines/utilities/repair-logical-tables.md
Outdated
Show resolved
Hide resolved
Deploying greptime-docs with
|
| Latest commit: |
d911142
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b330ad30.greptime-docs.pages.dev |
| Branch Preview URL: | https://issue-2310.greptime-docs.pages.dev |
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new CLI utility to repair partition column metadata mismatches (per issue #2310), and updates the documented syntax for the logical tables repair command.
Changes:
- Add new docs pages for
greptime cli meta repair partition-column(EN + ZH, current + v1.0). - Add the new page to sidebars (current + v1.0).
- Update logical-tables repair command syntax formatting (hyphenated → subcommand form) in EN + ZH docs.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.ts | Adds the new “repair partition columns” doc to the Utilities sidebar. |
| versioned_sidebars/version-1.0-sidebars.json | Adds the new “repair partition columns” doc to the v1.0 Utilities sidebar. |
| docs/reference/command-lines/utilities/repair-partition-columns.md | New current-version EN doc for partition-column repair. |
| versioned_docs/version-1.0/reference/command-lines/utilities/repair-partition-columns.md | New v1.0 EN doc for partition-column repair. |
| i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/repair-partition-columns.md | New current-version ZH doc for partition-column repair. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.0/reference/command-lines/utilities/repair-partition-columns.md | New v1.0 ZH doc for partition-column repair. |
| docs/reference/command-lines/utilities/repair-logical-tables.md | Updates EN logical-tables repair command syntax to subcommand form. |
| versioned_docs/version-1.0/reference/command-lines/utilities/repair-logical-tables.md | Updates v1.0 EN logical-tables repair command syntax to subcommand form. |
| i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/repair-logical-tables.md | Updates current-version ZH logical-tables repair command syntax to subcommand form. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.0/reference/command-lines/utilities/repair-logical-tables.md | Updates v1.0 ZH logical-tables repair command syntax to subcommand form. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...s-plugin-content-docs/version-1.0/reference/command-lines/utilities/repair-logical-tables.md
Outdated
Show resolved
Hide resolved
docs/reference/command-lines/utilities/repair-partition-columns.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-1.0/reference/command-lines/utilities/repair-partition-columns.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-1.0/reference/command-lines/utilities/repair-partition-columns.md
Outdated
Show resolved
Hide resolved
docs/reference/command-lines/utilities/repair-partition-columns.md
Outdated
Show resolved
Hide resolved
docs/reference/command-lines/utilities/repair-partition-columns.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-1.0/reference/command-lines/utilities/repair-partition-columns.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-1.0/reference/command-lines/utilities/repair-partition-columns.md
Show resolved
Hide resolved
...aurus-plugin-content-docs/current/reference/command-lines/utilities/repair-logical-tables.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
What's Changed in this PR
close #2310
Describe the change in this PR
Checklist
sidebars.tsmatches the current document structure when you changed the document structure.