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.

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

adjust the order of titles under Reference in TOC #12108

Merged
merged 2 commits into from Jan 18, 2023

Conversation

shichun-0415
Copy link
Contributor

@shichun-0415 shichun-0415 commented Jan 17, 2023

First-time contributors' checklist

What is changed, added or deleted? (Required)

According to the user visit data of the official documentation website in 2022, tiflash, configuration files, and system variables are obviously more frequently searched than other pages. It is assumed that this is because these contents are not in an easy-catch position in the navigation tree. Therefore, this PR moves the storage engine part out, and moves system variables, CLI, and configuration files upward, hoping that users can more easily catch these pages.

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)
  • v6.6 (TiDB 6.6 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.4 (TiDB 6.4 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)

What is the related PR or file 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
Copy link
Member

ti-chi-bot commented Jan 17, 2023

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

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

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 17, 2023
@shichun-0415 shichun-0415 added type/enhancement This issue/PR improves documentation usability or supplements document content. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. and removed missing-translation-status This PR does not have translation status info. labels Jan 17, 2023
Copy link
Contributor

@TomShawn TomShawn 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 added the status/LGT1 Indicates that a PR has LGTM 1. label Jan 18, 2023
@shichun-0415 shichun-0415 added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. require-LGT1 Indicates that the PR requires an LGTM. and removed translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. labels Jan 18, 2023
@shichun-0415
Copy link
Contributor Author

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 13eea44

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Jan 18, 2023
@ti-chi-bot ti-chi-bot merged commit af9b5a4 into pingcap:master Jan 18, 2023
@shichun-0415 shichun-0415 deleted the reference-toc branch January 18, 2023 11:22
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-6.5: #12160.

@shichun-0415 shichun-0415 added needs-cherry-pick-release-4.0 needs-cherry-pick-release-5.1 Should cherry pick this PR to release-5.1 branch. needs-cherry-pick-release-5.2 Should cherry pick this PR to release-5.2 branch. needs-cherry-pick-release-5.3 Should cherry pick this PR to release-5.3 branch. needs-cherry-pick-release-5.4 Should cherry pick this PR to release-5.4 branch. needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. labels Jan 20, 2023
@ti-chi-bot
Copy link
Member

@shichun-0415: new pull request created to branch release-5.2: #12216.

In response to this:

/cherrypick release-4.0
/cherrypick release-5.0
/cherrypick release-5.1
/cherrypick release-5.2
/cherrypick release-5.3
/cherrypick release-5.4
/cherrypick release-6.1
/cherrypick release-6.2
/cherrypick release-6.3
/cherrypick release-6.4

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 ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Member

@shichun-0415: new pull request created to branch release-5.3: #12217.

In response to this:

/cherrypick release-4.0
/cherrypick release-5.0
/cherrypick release-5.1
/cherrypick release-5.2
/cherrypick release-5.3
/cherrypick release-5.4
/cherrypick release-6.1
/cherrypick release-6.2
/cherrypick release-6.3
/cherrypick release-6.4

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 ti-community-infra/tichi repository.

ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Jan 20, 2023
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Jan 20, 2023
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot
Copy link
Member

@shichun-0415: new pull request created to branch release-5.4: #12218.

In response to this:

/cherrypick release-4.0
/cherrypick release-5.0
/cherrypick release-5.1
/cherrypick release-5.2
/cherrypick release-5.3
/cherrypick release-5.4
/cherrypick release-6.1
/cherrypick release-6.2
/cherrypick release-6.3
/cherrypick release-6.4

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 ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Member

@shichun-0415: new pull request created to branch release-6.1: #12219.

In response to this:

/cherrypick release-4.0
/cherrypick release-5.0
/cherrypick release-5.1
/cherrypick release-5.2
/cherrypick release-5.3
/cherrypick release-5.4
/cherrypick release-6.1
/cherrypick release-6.2
/cherrypick release-6.3
/cherrypick release-6.4

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 ti-community-infra/tichi repository.

ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Jan 20, 2023
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Jan 20, 2023
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot
Copy link
Member

@shichun-0415: new pull request created to branch release-6.2: #12220.

In response to this:

/cherrypick release-4.0
/cherrypick release-5.0
/cherrypick release-5.1
/cherrypick release-5.2
/cherrypick release-5.3
/cherrypick release-5.4
/cherrypick release-6.1
/cherrypick release-6.2
/cherrypick release-6.3
/cherrypick release-6.4

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 ti-community-infra/tichi repository.

ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Jan 20, 2023
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot
Copy link
Member

@shichun-0415: new pull request created to branch release-6.3: #12221.

In response to this:

/cherrypick release-4.0
/cherrypick release-5.0
/cherrypick release-5.1
/cherrypick release-5.2
/cherrypick release-5.3
/cherrypick release-5.4
/cherrypick release-6.1
/cherrypick release-6.2
/cherrypick release-6.3
/cherrypick release-6.4

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 ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Member

@shichun-0415: new pull request created to branch release-6.4: #12222.

In response to this:

/cherrypick release-4.0
/cherrypick release-5.0
/cherrypick release-5.1
/cherrypick release-5.2
/cherrypick release-5.3
/cherrypick release-5.4
/cherrypick release-6.1
/cherrypick release-6.2
/cherrypick release-6.3
/cherrypick release-6.4

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 ti-community-infra/tichi repository.

ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Jan 20, 2023
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
Oreoxmt pushed a commit to Oreoxmt/docs that referenced this pull request Jan 29, 2023
Signed-off-by: Aolin <aolin.zhang@pingcap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-cherry-pick-release-5.1 Should cherry pick this PR to release-5.1 branch. needs-cherry-pick-release-5.2 Should cherry pick this PR to release-5.2 branch. needs-cherry-pick-release-5.3 Should cherry pick this PR to release-5.3 branch. needs-cherry-pick-release-5.4 Should cherry pick this PR to release-5.4 branch. needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. require-LGT1 Indicates that the PR requires an LGTM. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT1 Indicates that a PR has LGTM 1. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. type/enhancement This issue/PR improves documentation usability or supplements document content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants