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

Quick start updates #19960

Merged
merged 16 commits into from
Jan 20, 2025
Merged

Quick start updates #19960

merged 16 commits into from
Jan 20, 2025

Conversation

likidu
Copy link
Collaborator

@likidu likidu commented Jan 10, 2025

What is changed, added or deleted? (Required)

Update wordings, notes orders to the Quick Start for TiDB Self-Managed doc.

  • Uses 1 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.
  • Revisited the wordings, such as the topology table.

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)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 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)

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

@likidu likidu requested a review from lilin90 January 10, 2025 20:28
@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 10, 2025
@Oreoxmt Oreoxmt self-requested a review January 13, 2025 04:21
@Oreoxmt Oreoxmt added translation/doing This PR's assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. labels Jan 13, 2025
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Jan 13, 2025

Uses 1 for ordered list, as it will increase automatically and can avoid the manual calculation of the numbers for the list.

@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 1.. The current format is causing a build failure at https://do.pingcap.net/jenkins/blue/organizations/jenkins/pingcap%2Fdocs%2Fpull_verify/detail/pull_verify/10066/pipeline/.

While both formats render identically in Markdown, we require explicit sequential numbering for several reasons:

  1. It maintains source content readability
  2. It ensures consistency with our existing documentation style
  3. It facilitates precise cross-referencing between steps (e.g., "as shown in step 2")
  4. It simplifies document maintenance and review

Please update the ordered lists to use sequential numbers instead of repeated 1.. For example:

1. First step
2. Second step
3. Third step

quick-start-with-tidb.md Outdated Show resolved Hide resolved

- To view the currently deployed cluster list:
1. To view the currently deployed cluster list:
Copy link
Collaborator

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:

- 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>
```

quick-start-with-tidb.md Outdated Show resolved Hide resolved
quick-start-with-tidb.md Outdated Show resolved Hide resolved
@lilin90 lilin90 added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Jan 14, 2025
quick-start-with-tidb.md Outdated Show resolved Hide resolved
quick-start-with-tidb.md Outdated Show resolved Hide resolved
@lilin90 lilin90 self-assigned this Jan 14, 2025
@lilin90 lilin90 added the type/enhancement The issue or PR belongs to an enhancement. label Jan 14, 2025
@likidu
Copy link
Collaborator Author

likidu commented Jan 15, 2025

Further updated the content to address the feedback.

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

ti-chi-bot bot commented Jan 16, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-01-16 09:01:34.520966891 +0000 UTC m=+195565.976013058: ☑️ agreed by Oreoxmt.

@lilin90 lilin90 added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 16, 2025
@lilin90
Copy link
Member

lilin90 commented Jan 16, 2025

I'll make some minor updates soon.

@lilin90 lilin90 removed the translation/doing This PR's assignee is translating this PR. label Jan 16, 2025
@ti-chi-bot ti-chi-bot bot added the missing-translation-status This PR does not have translation status info. label Jan 16, 2025
@lilin90 lilin90 added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Jan 16, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Jan 16, 2025
Comment on lines +159 to +163
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
Copy link
Member

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.

@lilin90 lilin90 requested a review from xhebox January 17, 2025 09:39
Copy link

ti-chi-bot bot commented Jan 20, 2025

@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.

@lilin90
Copy link
Member

lilin90 commented Jan 20, 2025

/unhold

@ti-chi-bot ti-chi-bot bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 20, 2025
@lilin90 lilin90 added the lgtm label Jan 20, 2025
@lilin90
Copy link
Member

lilin90 commented Jan 20, 2025

/approve

Copy link

ti-chi-bot bot commented Jan 20, 2025

[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 /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 20, 2025
@ti-chi-bot ti-chi-bot bot merged commit cdc3caa into pingcap:master Jan 20, 2025
9 checks passed
@ti-chi-bot
Copy link
Member

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

ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Jan 20, 2025
ti-chi-bot bot pushed a commit that referenced this pull request Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants