Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cloud: optimize TOC and add concept docs #19717

Open
wants to merge 32 commits into
base: release-8.1
Choose a base branch
from
Open

cloud: optimize TOC and add concept docs #19717

wants to merge 32 commits into from
+1,423 −483

Conversation

qiancai
Copy link
Collaborator

@qiancai qiancai commented Dec 17, 2024 •
edited
Loading

What is changed, added or deleted? (Required)

  1. Optimize the doc structure in the left navigation pane by grouping first-level documentation entries into categories.
  2. Add a series of key concept documents to make TiDB Cloud documentation more intuitive and helpful for new users

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)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 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)
  • v5.3 (TiDB 5.3 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

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 17, 2024
@qiancai qiancai added type/enhancement The issue or PR belongs to an enhancement. translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. and removed missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 17, 2024
@qiancai qiancai self-assigned this Dec 17, 2024
@qiancai qiancai changed the title cloud: add concept docs [WIP]: cloud: add concept docs Dec 17, 2024
@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 Dec 17, 2024
@qiancai qiancai added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Dec 17, 2024
@qiancai qiancai marked this pull request as draft December 20, 2024 02:57
qiancai
qiancai commented Dec 31, 2024
View reviewed changes
TOC-tidb-cloud.md Outdated Show resolved Hide resolved
qiancai
qiancai commented Dec 31, 2024
View reviewed changes
TOC-tidb-cloud.md Outdated Show resolved Hide resolved
shhdgit
shhdgit reviewed Jan 2, 2025
View reviewed changes
tidb-cloud/architecture-cocepts.md Outdated
@@ -0,0 +1,98 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

tidb-cloud/architecture-cocepts.md -> tidb-cloud/architecture-concepts.md

shhdgit
shhdgit reviewed Jan 2, 2025
View reviewed changes
TOC-tidb-cloud.md Outdated Show resolved Hide resolved
@qiancai qiancai marked this pull request as ready for review January 3, 2025 07:28
qiancai
qiancai commented Jan 9, 2025
View reviewed changes
tidb-cloud/sql-concepts.md Outdated Show resolved Hide resolved
@qiancai qiancai changed the title [WIP]: cloud: add concept docs [WIP]: cloud: optimize TOC and add concept docs Jan 9, 2025
lilin90
lilin90 reviewed Jan 10, 2025
View reviewed changes
tidb-cloud/sql-concepts.md Outdated Show resolved Hide resolved
lilin90
lilin90 approved these changes Jan 10, 2025
View reviewed changes
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

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

/lgtm

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jan 10, 2025
@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 10, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-01-10 02:07:53.29934635 +0000 UTC m=+492216.588178056: ☑️ agreed by lilin90.

@lilin90 lilin90 changed the title [WIP]: cloud: optimize TOC and add concept docs cloud: optimize TOC and add concept docs Jan 10, 2025
@ti-chi-bot ti-chi-bot bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 10, 2025
@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 10, 2025

@Frank945946: adding LGTM is restricted to approvers and reviewers in OWNERS files.

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.

github-actions bot pushed a commit to qiancai/pingcap-docsite-preview that referenced this pull request Jan 10, 2025
Preview PR pingcap/docs#19717 and this preview is triggered from commit
35c28c3 
pingcap/docs@8272325
github-actions bot pushed a commit to qiancai/pingcap-docsite-preview that referenced this pull request Jan 10, 2025
Preview PR pingcap/docs#19717 and this preview is triggered from commit
4e6e627 
pingcap/docs@0bbbbba
qiancai
qiancai commented Jan 10, 2025
View reviewed changes
TOC-tidb-cloud.md Outdated Show resolved Hide resolved
github-actions bot pushed a commit to qiancai/pingcap-docsite-preview that referenced this pull request Jan 10, 2025
Preview PR pingcap/docs#19717 and this preview is triggered from commit
99ca52f 
pingcap/docs@fcb540e
@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 10, 2025

@ljun0712: adding LGTM is restricted to approvers and reviewers in OWNERS files.

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.

@qiancai
Copy link
Collaborator Author

qiancai commented Jan 10, 2025

/approve

@qiancai qiancai added the lgtm label Jan 10, 2025
@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 10, 2025

[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

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

@ti-chi-bot ti-chi-bot bot added the approved label Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shhdgit shhdgit shhdgit left review comments

@Frank945946 Frank945946 Frank945946 approved these changes

@joey-yez joey-yez joey-yez approved these changes

@ljun0712 ljun0712 ljun0712 approved these changes

@lilin90 lilin90 lilin90 approved these changes

@sunxiaoguang sunxiaoguang sunxiaoguang approved these changes

Assignees

@qiancai qiancai

Labels
approved area/tidb-cloud This PR relates to the area of TiDB Cloud. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/no-need No need to translate this PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@qiancai @sunxiaoguang @shhdgit @lilin90 @ljun0712 @joey-yez @Frank945946