-
Notifications
You must be signed in to change notification settings - Fork 688
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
Quick start updates #19960
Quick start updates #19960
Conversation
@likidu According to our Markdown Lint rules (https://github.com/pingcap/docs/blob/master/.markdownlint.yaml), ordered lists must use sequential numbering (1, 2, 3) rather than repeated While both formats render identically in Markdown, we require explicit sequential numbering for several reasons:
Please update the ordered lists to use sequential numbers instead of repeated 1. First step
2. Second step
3. Third step
|
quick-start-with-tidb.md
Outdated
|
||
- To view the currently deployed cluster list: | ||
1. To view the currently deployed cluster list: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use bullet points (-
) instead of ordered numbers (1.
, 2.
) here because these items represent independent commands, not sequential steps that must be performed in order:
Lines 495 to 509 in 8234ff0
- To view the currently deployed cluster list: | |
{{< copyable "shell-regular" >}} | |
```shell | |
tiup cluster list | |
``` | |
- To view the cluster topology and status: | |
{{< copyable "shell-regular" >}} | |
```shell | |
tiup cluster display <cluster-name> | |
``` |
Co-authored-by: Aolin <[email protected]>
Co-authored-by: Aolin <[email protected]>
Further updated the content to address the feedback. |
[LGTM Timeline notifier]Timeline:
|
I'll make some minor updates soon. |
Detected shell: bash | ||
Shell profile: /home/user/.bashrc | ||
/home/user/.bashrc has been modified to add tiup to PATH | ||
open a new terminal or source /home/user/.bashrc to use it | ||
Installed path: /home/user/.tiup/bin/tiup |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For reviewer: This is to align the output with that in Chinese docs.
@xhebox: 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. |
/unhold |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lilin90 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 |
In response to a cherrypick label: new pull request created to branch |
Signed-off-by: ti-chi-bot <[email protected]>
What is changed, added or deleted? (Required)
Update wordings, notes orders to the Quick Start for TiDB Self-Managed doc.
Uses1
for ordered list, as it will increase automatically and can avoid the manual calculation of the numbers for the list.Tries to move the NOTE section after the main content. Some of the notes should be after the major content as they are more like extended content.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?