refactor: consolidate TOC file handling in cloud document scripts #21512
Conversation
ti-chi-bot
bot
added
missing-translation-status
… cloud document scripts
…tency in cloud document scripts
…ud document scripts
…onCloudDoc script
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @shhdgit, 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!
I've refactored the handling of Table of Contents (TOC) files within the cloud document scripts. My goal was to consolidate the logic for identifying and processing cloud-related documentation, making the system more robust and easier to manage. This involved centralizing the list of cloud TOC files, enhancing existing scripts to work with this consolidated list, and introducing a new script to streamline the initialization and copying of relevant cloud documentation files.
Highlights
- Centralized Cloud TOC List: I've introduced a new constant,
CLOUD_TOC_LIST, which centralizes the definition of all relevant cloud Table of Contents (TOC) files. This promotes consistency and simplifies maintenance across different scripts that need to reference these files. - Consolidated TOC Processing: The
filterCloudDoc.jsscript has been enhanced to process all TOC files listed inCLOUD_TOC_LIST. It now aggregates and deduplicates all markdown links from these files, ensuring a comprehensive and unique list of cloud documentation files for further processing. - Automated Cloud Document Initialization: I've added a new script,
filterCloudInitFiles.js, which automates the process of preparing cloud documentation. This script intelligently filters out irrelevant links (like external URLs or anchor links) and copies only the necessary markdown files to a temporary directory, streamlining the documentation build process. - Improved Non-Cloud Document Filtering: The
filterNonCloudDoc.jsscript now leverages the newCLOUD_TOC_LISTto more accurately identify and skip cloud-specific TOC files, ensuring that non-cloud documentation processing remains focused and efficient.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request refactors the cloud documentation scripts to handle multiple Table of Contents (TOC) files, which is a good improvement. My review focuses on further improving maintainability by addressing the code duplication introduced by these changes. I've suggested centralizing the new CLOUD_TOC_LIST constant and its processing logic into a shared utility file to adhere to the DRY principle and make future updates easier.
[LGTM Timeline notifier]Timeline:
|
ti-chi-bot
bot
removed
the
missing-translation-status
lilin90
added
missing-translation-status
lilin90
changed the title
lilin90
changed the title
lilin90
added
needs-cherry-pick-master
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lilin90 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
merged commit d6d6c51
into
pingcap:feature/preview-starter
|
In response to a cherrypick label: new pull request created to branch |
|
In response to a cherrypick label: new pull request created to branch |
Signed-off-by: ti-chi-bot <[email protected]>
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?