fix: quote YAML frontmatter values to resolve Vale parsing error #21826
Conversation
Oreoxmt
added
translation/no-need
Summary of ChangesHello @Oreoxmt, 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 addresses a parsing issue with newer versions of the Vale linter by ensuring that YAML frontmatter values which include template syntax are correctly enclosed in double quotes. This change is crucial for maintaining the integrity of the documentation build process, allowing files to be processed without errors by the linter. Highlights
Using Gemini Code AssistThe 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
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 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
|
ti-chi-bot
bot
added
the
size/XS
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request addresses a Vale parsing error by quoting a YAML frontmatter value that contains template syntax. The change in tidb-cloud/serverless-faqs.md is a good step. However, the fix is incomplete. In the same file, the summary field also contains template syntax and should be quoted to prevent parsing errors. I've added a specific comment for that.
Additionally, I've noticed several other files in the repository that have the same issue with unquoted template syntax in their YAML frontmatter. To resolve the Vale parsing error consistently, please consider updating these files as well:
tidb-cloud/serverless-limitations.mdtidb-cloud/manage-serverless-spend-limit.mdtidb-cloud/secure-connections-to-serverless-clusters.md
Applying this change consistently across all relevant files will improve the documentation's integrity.
[LGTM Timeline notifier]Timeline:
|
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt 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 |
2 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
Newer versions of Vale require YAML values containing template syntax to be quoted to parse correctly.
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?