Skip to content

docs: repair partition columns utility#2333

Open
MichaelScofield wants to merge 4 commits intomainfrom
issue-2310
Open

docs: repair partition columns utility#2333
MichaelScofield wants to merge 4 commits intomainfrom
issue-2310

Conversation

@MichaelScofield
Copy link
Contributor

What's Changed in this PR

close #2310

Describe the change in this PR

Checklist

  • Please confirm that all corresponding versions of the documents have been revised.
  • Please ensure that the content in sidebars.ts matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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

  • New Documentation for Partition Column Repair: Introduced a comprehensive guide for a new greptime cli meta repair partition-column utility, which helps address and fix inconsistencies in table metadata related to partition columns, particularly issues arising before PR-6494.
  • Command Syntax Correction: Updated the command syntax for the greptime cli meta repair-logical-tables utility, changing the hyphen to a space (repair logical-tables) across all relevant English and Chinese documentation versions.
  • Documentation Structure Updates: Integrated the new partition column repair documentation into the sidebar navigation for both current and versioned documentation, ensuring discoverability for users.
  • Localization Support: Ensured that all new and updated documentation is available in both English and Chinese, including current and versioned content.
Changelog
  • docs/reference/command-lines/utilities/repair-logical-tables.md
    • Updated the command syntax from greptime cli meta repair-logical-tables to greptime cli meta repair logical-tables.
  • docs/reference/command-lines/utilities/repair-partition-columns.md
    • Added a new documentation page detailing the greptime cli meta repair partition-column utility.
    • Included sections on when to use the tool, command syntax, available options, and an example.
  • i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/repair-logical-tables.md
    • Updated the Chinese localized command syntax for greptime cli meta repair-logical-tables to greptime cli meta repair logical-tables.
  • i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/repair-partition-columns.md
    • Added the Chinese localized documentation for the new greptime cli meta repair partition-column utility.
  • i18n/zh/docusaurus-plugin-content-docs/version-1.0/reference/command-lines/utilities/repair-logical-tables.md
    • Updated the Chinese localized command syntax for greptime cli meta repair-logical-tables to greptime cli meta repair logical-tables for version 1.0.
  • i18n/zh/docusaurus-plugin-content-docs/version-1.0/reference/command-lines/utilities/repair-partition-columns.md
    • Added the Chinese localized documentation for the new greptime cli meta repair partition-column utility for version 1.0.
  • sidebars.ts
    • Added reference/command-lines/utilities/repair-partition-columns to the main sidebar navigation.
  • versioned_docs/version-1.0/reference/command-lines/utilities/repair-logical-tables.md
    • Updated the command syntax from greptime cli meta repair-logical-tables to greptime cli meta repair logical-tables for version 1.0 documentation.
  • versioned_docs/version-1.0/reference/command-lines/utilities/repair-partition-columns.md
    • Added the new documentation page for the greptime cli meta repair partition-column utility for version 1.0.
  • versioned_sidebars/version-1.0-sidebars.json
    • Added reference/command-lines/utilities/repair-partition-columns to the version 1.0 sidebar navigation.
Activity
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 9, 2026

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: d911142
Status: ✅  Deploy successful!
Preview URL: https://b330ad30.greptime-docs.pages.dev
Branch Preview URL: https://issue-2310.greptime-docs.pages.dev

View logs

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

MichaelScofield and others added 3 commits February 9, 2026 19:51
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>
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.

Update docs for feat: cli tool to repair partition columns mismatch

1 participant