*: update TiDB Cloud, Coprocessor, TiFlash docs#23065
Conversation
Multiple documentation updates across TiDB Cloud, Coprocessor Cache, and TiFlash docs: - coprocessor-cache.md: Wrap Grafana monitoring panel section in a premium CustomContent block and add related content. - tidb-cloud/cli-reference.md: Mark TiDB Cloud CLI Reference title as "(Beta)". - tidb-cloud/create-tidb-cluster-serverless.md & tidb-cloud/tidb-cloud-quickstart.md: Improve note formatting, add a clarification that TiDB Cloud is fully managed, and add links to the CLI Reference (Beta). Also normalize SQL comment formatting in the quickstart. - tiflash/tiflash-results-materialization.md: Restore and relocate the "Execution process" and "Restrictions" sections (including platform-specific CustomContent blocks for tidb and tidb-cloud) after the example, and clean up formatting and wording. These changes are mostly editorial and structural, improving clarity and surfacing the CLI reference and monitoring guidance.
lilin90
added
type/enhancement
|
[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 |
ti-chi-bot
Bot
added
the
size/L
There was a problem hiding this comment.
Note
Note for reviewers: This PR only updates the order of content paragraphs, removes a punctuation typo, and refines wording.
![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 updates several documentation files to add information about the TiDB Cloud CLI (Beta), clarify that TiDB Cloud is a fully managed service, note the unavailability of the copr-cache panel on starter/essential instances, and reorganize sections in the TiFlash results materialization guide. The reviewer's feedback focuses on adhering to the style guide by correcting a typo, avoiding passive voice, writing in the second person, and removing unnecessary words (like "Currently") to improve clarity and conciseness.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
|
||
| > **Note:** | ||
| > | ||
| > Currently, the **copr-cache** panel is not available on {{{ .starter }}} and {{{ .essential }}} instances. |
Remove an extra blank line at the end of tiflash/tiflash-results-materialization.md to clean up file formatting; no content changes to the document body.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Address minor grammar and clarity issues in tiflash-results-materialization.md: remove an extraneous apostrophe in the SQL mode clause, and rephrase the TiDB memory-limit notes to an active/consistent wording ("You can adjust...") in both TiDB and TiDB Cloud sections for clarity and consistency.
…into improve-cloud-docs
lilin90
changed the title
| > **Note:** | ||
| > | ||
| > The **copr-cache** panel is unavailable for {{{ .starter }}} and {{{ .essential }}} instances. |
Move the reference to disabling the columnPruner rule into platform-specific <CustomContent> blocks for tidb-cloud and tidb in column-pruning.md. The main text remains unchanged; this adds platform-scoped sections containing the link to the Blocklist of Optimization Rules and Expression Pushdown documentation.
There was a problem hiding this comment.
@qiqi-power Would you please review the update in column-pruning.md? Thanks!
Note
The sentence wrapped in CustomContent will only show in TiDB Self-Managed and TiDB Cloud Dedicated docs.
1 participant
What is changed, added or deleted? (Required)
Multiple documentation updates across TiDB Cloud, Coprocessor Cache, and TiFlash docs:
These changes are mostly editorial and structural, improving clarity and surfacing the CLI reference and monitoring guidance.
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?