Skip to content

cloud-lake: standardize front matter in 1000+ Markdown files#22573

Merged
lilin90 merged 11 commits intopingcap:feature/preview-cloud-lakefrom
lilin90:update-front-matter
Mar 18, 2026
Merged

cloud-lake: standardize front matter in 1000+ Markdown files#22573
lilin90 merged 11 commits intopingcap:feature/preview-cloud-lakefrom
lilin90:update-front-matter

Conversation

@lilin90
Copy link
Member

@lilin90 lilin90 commented Mar 18, 2026

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@lilin90 lilin90 self-assigned this Mar 18, 2026
@lilin90 lilin90 added the area/tidb-cloud This PR relates to the area of TiDB Cloud. label Mar 18, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 18, 2026

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 18, 2026
@lilin90 lilin90 marked this pull request as ready for review March 18, 2026 05:49
@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. and removed do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Mar 18, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 18, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from lilin90. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@lilin90 lilin90 added translation/doing This PR's assignee is translating this PR. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. and removed missing-translation-status This PR does not have translation status info. labels Mar 18, 2026
@ti-chi-bot ti-chi-bot bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Mar 18, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 tidb-cloud-lake directory. It involved a large-scale standardization effort across more than a hundred Markdown files, primarily by introducing a summary field to each file's front matter. This change not only improves the descriptive metadata for each document but also streamlines the front matter by removing outdated or redundant fields. Additionally, several document titles were updated to align with the 'TiDB Cloud Lake' branding, ensuring a unified user experience.

Highlights

  • Standardized Front Matter: Over 100 Markdown files in the /tidb-cloud-lake/ directory now include a summary field in their front matter, enhancing metadata consistency and content discoverability.
  • Metadata Cleanup: Redundant or deprecated front matter fields such as sidebar_label, sidebar_position, description, id, slug, and title_includes were removed or consolidated across numerous files.
  • Product Name Alignment: Many document titles were updated to consistently reflect 'TiDB Cloud Lake' instead of 'Databend', ensuring unified product branding throughout the documentation.

🧠 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 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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. 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

  1. 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.

lilin90 added 2 commits March 18, 2026 13:57
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.
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@@ -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'.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
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
  1. The style guide emphasizes clarity and readability. A summary containing code imports is not user-friendly. (link)

@@ -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'.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
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
  1. 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:.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The summary should be a descriptive sentence, not just 'Syntax:.'. This violates the clarity and completeness principles of the documentation style guide.

Suggested change
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
  1. The style guide emphasizes clarity and completeness. A summary should describe the page content. (link)

lilin90 added 2 commits March 18, 2026 15:19
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.
lilin90 and others added 4 commits March 18, 2026 15:41
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Lilian Lee <lilin@pingcap.com>
@lilin90 lilin90 requested a review from Oreoxmt March 18, 2026 07:58
@lilin90 lilin90 removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 18, 2026
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Mar 18, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 18, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-03-18 07:59:47.813812807 +0000 UTC m=+343914.901470344: ☑️ agreed by Oreoxmt.

@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 18, 2026

@Oreoxmt: Your lgtm message is repeated, so it is ignored.

Details

In 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.

@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 18, 2026

@lilin90: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify e6297d4 link true /test pull-verify

Full PR test history. Your PR dashboard.

Details

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. I understand the commands that are listed here.

@lilin90 lilin90 merged commit 58e6b48 into pingcap:feature/preview-cloud-lake Mar 18, 2026
7 of 10 checks passed
@lilin90 lilin90 deleted the update-front-matter branch March 18, 2026 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tidb-cloud This PR relates to the area of TiDB Cloud. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/doing This PR's assignee is translating this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants