Skip to content

docs(datanode): add scanbench CLI docs and tidy objbench options (EN/ZH, v1.0)#2365

Open
evenyag wants to merge 3 commits intomainfrom
codex/github-mention-update-docs-for-feat-add-a-subcommand-to-be
Open

docs(datanode): add scanbench CLI docs and tidy objbench options (EN/ZH, v1.0)#2365
evenyag wants to merge 3 commits intomainfrom
codex/github-mention-update-docs-for-feat-add-a-subcommand-to-be

Conversation

@evenyag
Copy link
Contributor

@evenyag evenyag commented Mar 9, 2026

Motivation

  • Provide documentation for a new scanbench subcommand that benchmarks region scans directly from storage and documents its options and usage.
  • Improve readability and formatting of the existing objbench options table and fix the missing newline at end-of-file.

Description

  • Adds a scanbench section to docs/reference/command-lines/datanode.md with an options table, scan-config JSON example, explanatory notes, and multiple usage examples including profiling options.
  • Mirrors the same scanbench documentation into Chinese localization files under i18n/zh/docusaurus-plugin-content-docs/current/... and i18n/zh/docusaurus-plugin-content-docs/version-1.0/....
  • Updates the versioned docs at versioned_docs/version-1.0/reference/command-lines/datanode.md and reformats the objbench options table and EOF newline across modified files.

Testing

  • No automated tests were run for this documentation-only change.

Codex Task

@cloudflare-workers-and-pages
Copy link

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

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0af1ca3
Status: ✅  Deploy successful!
Preview URL: https://c91c9cb6.greptime-docs.pages.dev
Branch Preview URL: https://codex-github-mention-update-hiqr.greptime-docs.pages.dev

View logs

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 datanode command-line documentation by introducing a new section for the scanbench subcommand. This new documentation provides users with detailed information on how to benchmark region scans directly from storage, including various options and configuration examples. Concurrently, it refines the existing objbench documentation by improving table formatting and addressing minor file integrity issues, ensuring a more consistent and user-friendly experience across all documentation versions and languages.

Highlights

  • New scanbench CLI Documentation: Introduced comprehensive documentation for the new scanbench subcommand, detailing its options, scan-config JSON structure, and various usage examples for benchmarking region scans.
  • Improved objbench Documentation: Enhanced the readability and formatting of the existing objbench options table.
  • Documentation Localization: Mirrored the new scanbench documentation into Chinese localization files for both current and versioned documentation.
  • File Formatting Consistency: Addressed and fixed missing newlines at the end of all modified documentation files to ensure consistent formatting.
Changelog
  • docs/reference/command-lines/datanode.md
    • Reformatted the objbench options table for improved readability.
    • Added a new scanbench section, including its options, scan-config JSON examples, explanatory notes, and multiple usage examples.
    • Ensured the file ends with a newline.
  • i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/datanode.md
    • Reformatted the objbench options table.
    • Added the Chinese localized scanbench section with options, scan-config JSON examples, notes, and usage examples.
    • Ensured the file ends with a newline.
  • i18n/zh/docusaurus-plugin-content-docs/version-1.0/reference/command-lines/datanode.md
    • Reformatted the objbench options table.
    • Added the Chinese localized scanbench section with options, scan-config JSON examples, notes, and usage examples.
    • Ensured the file ends with a newline.
  • versioned_docs/version-1.0/reference/command-lines/datanode.md
    • Reformatted the objbench options table for improved readability.
    • Added a new scanbench section, including its options, scan-config JSON examples, explanatory notes, and multiple usage examples.
    • Ensured the file ends with a newline.
Activity
  • No specific activity (comments, reviews, progress) has been recorded for this pull request yet.
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

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5f54df8d58

ℹ️ 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".

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 comprehensive documentation for the new scanbench subcommand and improves the formatting of the existing objbench documentation. The changes are applied consistently across both English and Chinese documents for current and versioned docs. The new documentation is well-structured and provides clear examples. I've made a few suggestions to improve consistency and clarity in the examples and option descriptions. Specifically, I've pointed out a confusing example in the scan-config JSON, an inconsistent path format in one of the command examples, and a minor formatting improvement for placeholders in the English documentation.

Note: Security Review has been skipped due to the limited scope of the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant