Update TiDB Cloud Lake quick start#23044
Conversation
|
[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 |
There was a problem hiding this comment.
Code Review
This pull request updates the TiDB Cloud Lake Quick Start guide to reflect the new initialization and workspace exploration steps. The review comments suggest minor formatting and consistency improvements, such as capitalizing list item descriptions, lowercasing "lake" when referring to the instance, and simplifying the Step 3 heading.
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.
| - **Name**: enter a name for your Lake. | ||
| - **Plan**: select a plan that fits your use case. | ||
| - **Cloud Provider and Region**: select the deployment region. |
There was a problem hiding this comment.
Capitalize the first letter of the description for each list item to maintain professional and consistent formatting. Additionally, lowercase "Lake" to "lake" when referring to the instance itself, consistent with how "warehouse" was handled in the previous version of this document.
| - **Name**: enter a name for your Lake. | |
| - **Plan**: select a plan that fits your use case. | |
| - **Cloud Provider and Region**: select the deployment region. | |
| - **Name**: Enter a name for your lake. | |
| - **Plan**: Select a plan that fits your use case. | |
| - **Cloud Provider and Region**: Select the deployment region. |
| 4. Click **Create** and wait for initialization to complete. | ||
|
|
||
| ## Step 3. Explore the warehouse | ||
| ## Step 3. Explore your lake workspace |
There was a problem hiding this comment.
Simplify the heading to "Explore your workspace" to match the summary on line 3 ("explore your workspace") and avoid unnecessary words.
| ## Step 3. Explore your lake workspace | |
| ## Step 3. Explore your workspace |
References
- Avoid unnecessary words and repetition. (link)
| 1. Go back to **My Lake** and click the warehouse name you just created. | ||
| 2. You will be redirected to `lake.tidbcloud.com` where you can view the warehouse details and connection information. | ||
| 3. Use the connection information to connect from your preferred driver, or application. | ||
| 1. After initialization completes, confirm the Lake information on the home page, such as the Lake name, plan, cloud provider, and region. |
There was a problem hiding this comment.
Lowercase "Lake" to "lake" when referring to the instance itself (e.g., "lake information", "lake name") to maintain consistency with how "warehouse" was handled previously.
| 1. After initialization completes, confirm the Lake information on the home page, such as the Lake name, plan, cloud provider, and region. | |
| 1. After initialization completes, confirm the lake information on the home page, such as the lake name, plan, cloud provider, and region. |
References
- Use consistent terminology. (link)
| - **Connect**: get connection information. | ||
| - **Load Data** or **Load from Cloud Storage**: start loading data. | ||
| - **Query Data**: create a SQL worksheet. |
There was a problem hiding this comment.
Capitalize the first letter of the description for each list item to maintain professional and consistent formatting.
| - **Connect**: get connection information. | |
| - **Load Data** or **Load from Cloud Storage**: start loading data. | |
| - **Query Data**: create a SQL worksheet. | |
| - **Connect**: Get connection information. | |
| - **Load Data** or **Load from Cloud Storage**: Start loading data. | |
| - **Query Data**: Create a SQL worksheet. |
References
- Correct English grammar, spelling, and punctuation mistakes, if any. (link)
What is changed, added or deleted? (Required)
Update the TiDB Cloud Lake quick start guide to replace the warehouse creation flow with the Lake initialization flow. The guide now directs users to click Try TiDB Cloud Lake, configure the Lake name, plan, and region, and then explore the Lake home page.
Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
N/A
Do your changes match any of the following descriptions?
Checklist
./scripts/markdownlint tidb-cloud-lake/lake-quick-start.md.