hardware-and-software-requirements: Add note about supported filesystems (#21379) #21391
Conversation
ti-chi-bot
added
lgtm
needs-1-more-lgtm
![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 @ti-chi-bot, 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 primarily enhances the TiDB documentation by clarifying supported file systems for production environments. It also refines terminology by renaming 'Disk space requirements' to 'Storage requirements' for better accuracy and consistency within the hardware and software requirements guide.
Highlights
- Documentation Update: Supported Filesystems: A new note has been added to the
hardware-and-software-requirements.mdfile, explicitly stating that TiDB supports XFS and Ext4 file systems, and advises against using other file systems for production environments. - Documentation Refinement: Terminology: The section heading 'Disk space requirements' and its corresponding internal link within the hardware table have been updated to 'Storage requirements' in
hardware-and-software-requirements.mdfor improved clarity and broader scope. - Link Checker Configuration: The
.lycheeignorefile has been updated to include a new URL (https://developers.redhat.com/blog/2021/01/05/building-red-hat-enterprise-linux-9-for-the-x86-64-v2-microarchitecture-level), likely to prevent the link checker from flagging it.
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 is currently in preview and 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 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 adds a note about supported filesystems to the hardware and software requirements documentation, and updates a section heading for consistency. The changes are straightforward and mostly correct. I've added one suggestion to improve the wording of the new note and fix a minor formatting issue, aligning it better with the documentation style guide regarding active voice and use of the second person.
| @@ -292,6 +292,8 @@ As an open-source distributed SQL database, TiDB requires the following network | |||
| </tbody> | |||
| </table> | |||
|
|
|||
| TiDB supports the XFS and Ext4 file systems. Other file systems are not recommended for production environments. | |||
There was a problem hiding this comment.
This sentence is clear, but has a couple of minor issues:
- There are two trailing spaces at the end of the line. These are used for hard line breaks in Markdown, but are unnecessary here because the sentence is followed by a blank line to create a new paragraph.
- The phrase "Other file systems are not recommended" is in passive voice. The style guide recommends using active voice and addressing the user with "you".12
A more direct and active phrasing would be better. Here is a suggestion.
Style Guide References
| TiDB supports the XFS and Ext4 file systems. Other file systems are not recommended for production environments. | |
| TiDB supports the XFS and Ext4 file systems. For production environments, it is recommended that you use only these file systems. |
Footnotes
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai 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 |
This is an automated cherry-pick of #21379
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?