Repository navigation
tidb-cloud: remove Chat2Query documentation - #24549
Conversation
ti-chi-bot
Bot
added
area/develop
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
SQL Editor guide and quick start tidb-cloud/explore-data-with-chat2query.md, tidb-cloud/explore-data-with-sql-editor.md, tidb-cloud/tidb-cloud-quickstart.md, tidb-cloud/connect-to-tidb-cluster.md |
The new SQL Editor guide covers availability, query execution, SQL files, and settings. The quick start now demonstrates direct SQL with table creation, inserts, and a query. The cluster connection page describes writing and running queries. |
Chat2Query API and Data Service content tidb-cloud/use-chat2query-*.md, tidb-cloud/data-service-api-key.md, tidb-cloud/data-service-app-config-files.md, tidb-cloud/data-service-concepts.md, tidb-cloud/data-service-get-started.md, tidb-cloud/data-service-manage-data-app.md, tidb-cloud/data-service-manage-endpoint.md, tidb-cloud/data-service-overview.md, tidb-cloud/data-service-postman-integration.md, tidb-cloud/data-service-response-and-status-code.md |
The Chat2Query API, knowledge, and session guides were deleted. Data Service documentation removes related guidance and Chat2Data response examples. |
SQL Editor links and references TOC-tidb-cloud-starter.md, TOC-tidb-cloud.md, develop/serverless-driver-*-example.md, tidb-cloud/data-service-oas-with-nextjs.md, tidb-cloud/manage-user-access.md, tidb-cloud/sql-proxy-account.md, tidb-cloud/tidb-cloud-import-local-files.md |
Navigation, tutorials, role tables, and SQL-related instructions now link to the SQL Editor guide. |
Other Chat2Query references tidb-cloud/ai-feature-concepts.md, tidb-cloud/releases/release-notes-2023.md, tidb-cloud/releases/release-notes-2024.md, tidb-cloud/tidb-cloud-glossary.md, tidb-cloud/tidb-cloud-roadmap.md |
Chat2Query references were removed or unlinked in AI feature concepts, release notes, the glossary, and the roadmap. |
Priority:
Estimated code review effort: 3 (Moderate) | ~20 minutes
Change: Other
Possibly related PRs
- pingcap/docs#24556: Documents the removal of Chat2Query from SQL Editor and Data Service, including the Chat2Query API.
Suggested reviewers: lilin90
Merge Risk: 
6df6c
-
The documentation transition is mergeable with no supported outstanding correctness or availability risk.
Pre-merge checks: 
-
Check name Status Explanation Title check The title clearly and concisely describes the primary change: removing Chat2Query documentation. Description check The description covers the documentation removals, retained SQL Editor content, aliases, version scope, AI involvement, deleted files, and validation performed. It matches the required template struct… Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Description check
-
Explanation
The description covers the documentation removals, retained SQL Editor content, aliases, version scope, AI involvement, deleted files, and validation performed. It matches the required template structure sufficiently.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)
-
Finishing Touches: 💡 1
-
🛠️ Fix failing CI checks: 💡
-
- Commit to this branch
- Create a new PR
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔇 Additional comments: 7
TOC-tidb-cloud-starter.md: 1
138-138: LGTM!TOC-tidb-cloud.md: 1
174-174: LGTM!tidb-cloud/data-service-oas-with-nextjs.md: 1
25-25: LGTM!tidb-cloud/manage-user-access.md: 1
144-145: LGTM!Also applies to: 164-165
tidb-cloud/sql-proxy-account.md: 1
8-8: LGTM!tidb-cloud/tidb-cloud-import-local-files.md: 1
80-80: LGTM!tidb-cloud/explore-data-with-sql-editor.md-86-88: 1
86-88:Trivial · Maintainability & Code Quality · Quick win
⚠️ Unverified finding
Verification ran but could not confirm this finding. It is shown for review, not as a verified issue.Vary the repeated bullet openings.
LanguageTool flags these three consecutive bullets because each starts with
To. Start each instruction with its action to improve scanability without changing the procedure.Proposed replacement
Sources: Path instructions, Linters/SAST tools
-
-
- Source mode: Auto
- Repository: pingcap/docs
- Branch: release-8.5
- File: .coderabbit.yaml
- Commit: 6fa2484
- Layers: Repository YAML
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
57ab1b73-9f14-4410-9c78-87e915f0bdae
-
TOC-tidb-cloud-starter.mdTOC-tidb-cloud.mddevelop/serverless-driver-drizzle-example.mddevelop/serverless-driver-kysely-example.mdtidb-cloud/ai-feature-concepts.mdtidb-cloud/connect-to-tidb-cluster.mdtidb-cloud/data-service-api-key.mdtidb-cloud/data-service-app-config-files.mdtidb-cloud/data-service-concepts.mdtidb-cloud/data-service-get-started.mdtidb-cloud/data-service-manage-data-app.mdtidb-cloud/data-service-manage-endpoint.mdtidb-cloud/data-service-oas-with-nextjs.mdtidb-cloud/data-service-overview.mdtidb-cloud/data-service-postman-integration.mdtidb-cloud/data-service-response-and-status-code.mdtidb-cloud/explore-data-with-chat2query.mdtidb-cloud/explore-data-with-sql-editor.mdtidb-cloud/manage-user-access.mdtidb-cloud/releases/release-notes-2023.mdtidb-cloud/releases/release-notes-2024.mdtidb-cloud/sql-proxy-account.mdtidb-cloud/tidb-cloud-glossary.mdtidb-cloud/tidb-cloud-import-local-files.mdtidb-cloud/tidb-cloud-quickstart.mdtidb-cloud/tidb-cloud-roadmap.mdtidb-cloud/use-chat2query-api.mdtidb-cloud/use-chat2query-knowledge.mdtidb-cloud/use-chat2query-sessions.md
-
- tidb-cloud/data-service-api-key.md
- tidb-cloud/use-chat2query-knowledge.md
- tidb-cloud/data-service-concepts.md
- tidb-cloud/data-service-app-config-files.md
- tidb-cloud/data-service-manage-data-app.md
- tidb-cloud/tidb-cloud-glossary.md
- tidb-cloud/data-service-overview.md
- tidb-cloud/releases/release-notes-2024.md
- tidb-cloud/explore-data-with-chat2query.md
- tidb-cloud/use-chat2query-sessions.md
- tidb-cloud/use-chat2query-api.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
-
qiancai
changed the title
qiancai
added
translation/doing
Updated the title to indicate that SQL Editor is in preview and clarified its availability for starter instances.
|
@qqqdan: adding LGTM is restricted to approvers and reviewers in OWNERS files. 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. |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
In response to a cherrypick label: new pull request created to branch |
Synced from: pingcap/docs#24549 Target PR: pingcap#22010 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
What is changed, added or deleted? (Required)
Remove documentation for Chat2Query, which has been removed from the TiDB Cloud console, and its API, which is being retired.
explore-data-with-sql-editor.md, update inbound links, and redirect all four removed page URLs using aliases.Validation: scoped Markdownlint and internal link checks (25 files), plus
git diff --check.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)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit