hardware-and-software-requirements: Add note about supported filesystems (#21379) #21390
Conversation
Signed-off-by: ti-chi-bot <[email protected]>
ti-chi-bot
added
do-not-merge/hold
|
@dveeden This PR has conflicts, I have hold it. |
|
@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository. |
ti-chi-bot
bot
added
size/M
![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 updates the hardware-and-software-requirements.md documentation to provide explicit guidance on supported file systems for TiDB deployments. It also refines related terminology for consistency and updates the link checker's ignore list, potentially resolving issues with external documentation links.
Highlights
- Documentation Update: Added a crucial note to the
hardware-and-software-requirements.mdfile, specifying that TiDB officially supports XFS and Ext4 file systems, and advises against using others for production environments. - Terminology Refinement: Standardized terminology in
hardware-and-software-requirements.mdby changing 'Disk space requirements' to 'Storage requirements' for improved clarity and consistency. - Link Checker Configuration & Merge Artifact: Updated the
.lycheeignorefile by adding a significant number of new external URLs to be excluded from link checks. This change notably includes merge conflict markers within the committed content, suggesting an uncleaned merge or cherry-pick resolution.
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 documentation and renames a related section for clarity. The changes are generally good, but I've found a critical issue in .lycheeignore where merge conflict markers were left in the file. I've also provided a minor stylistic suggestion for the new documentation content in hardware-and-software-requirements.md to improve readability and adhere to the style guide.
.lycheeignore
Outdated
| https://github\.com/\$user/(docs|docs-cn) | ||
| ======= | ||
| https://github\.com/\$user/(docs|docs-cn) | ||
| https://linux\.die\.net/man.* | ||
| https://dev\.mysql\.com/doc/.+/5.7/en/.* | ||
| https://dev\.mysql\.com/doc/.+/8\.0/en/.* | ||
| https://dev\.mysql\.com/doc/.+/8\.4/en/.* | ||
| https://dev\.mysql\.com/doc/[a-z\-]+/en/.* | ||
| https://dev\.mysql\.com/doc/relnotes/[a-z\-]+/en/.* | ||
| https://dev\.mysql\.com/doc/dev/mysql-server/.* | ||
| https://dev\.mysql\.com/downloads/.* | ||
| https://bugs\.mysql\.com/bug\.php.* | ||
| https://www\.mysql\.com/products/.* | ||
| https://platform\.openai\.com/docs/.* | ||
| https://openai\.com/.* | ||
| https://jwt\.io/ | ||
| https://typeorm\.io/.* | ||
| https://dash\.cloudflare\.com/.* | ||
| https://centminmod\.com/mydumper\.html | ||
| https://docs\.pingcap\.com/tidb/v6\.6/system-variables#tidb_pessimistic_txn_aggressive_locking-new-in-v660 | ||
| https://docs\.pingcap\.com/tidb/v7\.6/system-variables#tidb_ddl_version-new-in-v760 | ||
| https://developers\.redhat\.com/blog/2021/01/05/building-red-hat-enterprise-linux-9-for-the-x86-64-v2-microarchitecture-level | ||
| >>>>>>> 21916eefd3 (hardware-and-software-requirements: Add note about supported filesystems (#21379)) |
There was a problem hiding this comment.
This file contains unresolved merge conflict markers (<<<<<<< HEAD, =======, >>>>>>>). These markers will break the link checker tooling that uses this file. Please resolve the conflict by removing the markers and combining the intended changes.
https://github\.com/\$user/(docs|docs-cn)
https://linux\.die\.net/man.*
https://dev\.mysql\.com/doc/.+/5.7/en/.*
https://dev\.mysql\.com/doc/.+/8\.0/en/.*
https://dev\.mysql\.com/doc/.+/8\.4/en/.*
https://dev\.mysql\.com/doc/[a-z\-]+/en/.*
https://dev\.mysql\.com/doc/relnotes/[a-z\-]+/en/.*
https://dev\.mysql\.com/doc/dev/mysql-server/.*
https://dev\.mysql\.com/downloads/.*
https://bugs\.mysql\.com/bug\.php.*
https://www\.mysql\.com/products/.*
https://platform\.openai\.com/docs/.*
https://openai\.com/.*
https://jwt\.io/
https://typeorm\.io/.*
https://dash\.cloudflare\.com/.*
https://centminmod\.com/mydumper\.html
https://docs\.pingcap\.com/tidb/v6\.6/system-variables#tidb_pessimistic_txn_aggressive_locking-new-in-v660
https://docs\.pingcap\.com/tidb/v7\.6/system-variables#tidb_ddl_version-new-in-v760
https://developers\.redhat\.com/blog/2021/01/05/building-red-hat-enterprise-linux-9-for-the-x86-64-v2-microarchitecture-level
ti-chi-bot
bot
added
size/S
qiancai
removed
the
do-not-merge/hold
|
/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?