docs: for gc

[discord9]

What's Changed in this PR

as title, add docs for gc config

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]

Summary of Changes

Hello @discord9, I'm Gemini Code Assist¹! 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 introduces essential documentation for the Garbage Collection (GC) feature in GreptimeDB. The new content clarifies the purpose and operational mechanics of GC, which is designed to safely manage the physical deletion of SST/index files by delaying removal until all active references, such as those from running queries or repartitioning workflows, are released. It also provides clear instructions on configuring GC parameters and offers practical advice on when and how to utilize this feature effectively.

Highlights

• New Documentation for Garbage Collection (GC): A new documentation page has been added at docs/user-guide/deployments-administration/gc/overview.md to provide a comprehensive guide on GreptimeDB's Garbage Collection (GC) feature.
• GC Mechanism Explained: The new document details how GC works, including the roles of the Meta GC scheduler and the Datanode GC worker, and the concept of lingering protection for files.
• Configuration Details: Configuration parameters for both Meta and Datanode components are outlined, specifying settings like enable, gc_cooldown_period, lingering_time, and unknown_file_lingering_time.
• Usage Guidelines: Guidance is provided on when to enable GC, particularly during repartitioning or for clusters with long-running queries, and when it can be safely left off.

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. ↩

[gemini-code-assist]

Code Review

This pull request adds a new documentation page for GreptimeDB's Garbage Collection feature. The document is comprehensive and covers the mechanism, configuration, and operational aspects of GC.

My review includes a couple of suggestions to improve the structure and presentation of the information:

• One suggestion is to use a warning block for a critical configuration note to make it more prominent, consistent with other documentation pages.
• Another suggestion addresses some redundancy between the 'How it works' and 'Operational notes' sections, recommending a consolidation of information to improve clarity and readability for the user.

Overall, this is a valuable addition to the documentation.

[cloudflare-workers-and-pages]

Deploying greptime-docs with    Cloudflare Pages

Latest commit:	70b1e26
Status:	✅  Deploy successful!
Preview URL:	https://ac110132.greptime-docs.pages.dev
Branch Preview URL:	https://gc.greptime-docs.pages.dev

View logs

[killme2008]

@discord9 Don't forget to add chinese version and update v1.0 documents.

[WenyXu]

Rest LGTM