cloud-lake: standardize front matter in 1000+ Markdown files#22573
cloud-lake: standardize front matter in 1000+ Markdown files#22573lilin90 merged 11 commits intopingcap:feature/preview-cloud-lakefrom
Conversation
|
Skipping CI for Draft Pull Request. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello, 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 significantly enhances the documentation quality and consistency for the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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. Footnotes
|
Standardize and simplify frontmatter summaries across multiple TiDB Cloud Lake guides: remove inline imports and stray markup, strip markdown emphasis and code ticks, and shorten/clarify several descriptions. Files changed: tidb-cloud-lake/guides/ai-powered-features.md (replace stray import string with concise summary), connect-using-dbeaver.md, connection-overview.md (limit to Databend Cloud), dashboards.md, data-purge-and-recycle.md (remove backticks around SQL commands), editions.md, full-text-index.md, and geo-analytics.md. These changes improve consistency and readability of guide metadata.
There was a problem hiding this comment.
Code Review
This pull request primarily focuses on updating and improving the summary metadata field across numerous Markdown documentation files. The changes involve making summaries more descriptive, concise, and consistent with the documentation's style guide. Specifically, many summaries were corrected to be complete sentences, remove code imports or markdown syntax, avoid repetitive phrasing, and ensure consistent terminology (e.g., replacing 'Databend' with 'TiDB Cloud Lake'). Additionally, a typo in a SQL command title [ NOT ] BETWEEN was identified for correction.
tidb-cloud-lake/guides/worksheet.md
Outdated
| @@ -1,7 +1,7 @@ | |||
| --- | |||
| title: Worksheets | |||
| summary: import DbSVG from '@site/static/img/icon/database.svg' import RoleSVG from '@site/static/img/icon/role.svg' import WarehouseSVG from '@site/static/img/icon/warehouse.svg' import EllipsisSVG from '@site/static/img/icon/ellipsis.svg'. | |||
There was a problem hiding this comment.
The summary should be a descriptive sentence about the topic, not code imports. This violates the clarity and readability principles of the documentation style guide.
| summary: import DbSVG from '@site/static/img/icon/database.svg' import RoleSVG from '@site/static/img/icon/role.svg' import WarehouseSVG from '@site/static/img/icon/warehouse.svg' import EllipsisSVG from '@site/static/img/icon/ellipsis.svg'. | |
| summary: Worksheets in TiDB Cloud Lake are used to organize, run, and save SQL statements. They can also be shared with others in your organization. |
References
- The style guide emphasizes clarity and readability. A summary containing code imports is not user-friendly. (link)
tidb-cloud-lake/guides/warehouse.md
Outdated
| @@ -1,7 +1,7 @@ | |||
| --- | |||
| title: Warehouses | |||
| summary: import PlaySVG from '@site/static/img/icon/play.svg' import SuspendSVG from '@site/static/img/icon/suspend.svg' import CheckboxSVG from '@site/static/img/icon/checkbox.svg' import EllipsisSVG from '@site/static/img/icon/ellipsis.svg' import { Button } from 'antd'. | |||
There was a problem hiding this comment.
The summary should be a descriptive sentence about the topic, not code imports. This violates the clarity and readability principles of the documentation style guide.
| summary: import PlaySVG from '@site/static/img/icon/play.svg' import SuspendSVG from '@site/static/img/icon/suspend.svg' import CheckboxSVG from '@site/static/img/icon/checkbox.svg' import EllipsisSVG from '@site/static/img/icon/ellipsis.svg' import { Button } from 'antd'. | |
| summary: The warehouse is an essential component of TiDB Cloud Lake. A warehouse represents a set of compute resources including CPU, memory, and local caches. You must run a warehouse to perform SQL tasks. |
References
- The style guide emphasizes clarity and readability. A summary containing code imports is not user-friendly. (link)
| @@ -1,7 +1,7 @@ | |||
| --- | |||
| title: Unloading TSV File | |||
| summary: Syntax:. | |||
There was a problem hiding this comment.
The summary should be a descriptive sentence, not just 'Syntax:.'. This violates the clarity and completeness principles of the documentation style guide.
| summary: Syntax:. | |
| summary: Learn how to unload data from TiDB Cloud Lake into TSV files, including syntax and examples for creating stages and custom file formats. |
References
- The style guide emphasizes clarity and completeness. A summary should describe the page content. (link)
Update frontmatter 'summary' fields across several TiDB Cloud Lake guides to be concise and descriptive. Removed embedded SQL/example snippets and stray JS import lines that were accidentally placed in summaries, and shortened redundant text for clarity. Affected files: tidb-cloud-lake/guides/query-parquet-files-in-stage.md, query-tsv-files-in-stage.md, sql-analytics.md, stage-overview.md, warehouse.md, and worksheet.md.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Lilian Lee <lilin@pingcap.com>
…into update-front-matter
[LGTM Timeline notifier]Timeline:
|
|
@Oreoxmt: Your lgtm message is repeated, so it is ignored. DetailsIn response to this: 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 kubernetes-sigs/prow repository. |
|
@lilin90: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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 kubernetes-sigs/prow repository. I understand the commands that are listed here. |
58e6b48
into
pingcap:feature/preview-cloud-lake
What is changed, added or deleted? (Required)
Checked and standardized front matter for all Markdown files in the
/tidb-cloud-lake/directory.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?