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

*: update TOC and title wording for on-boarding docs #19353

Merged
merged 15 commits into from
Nov 15, 2024

Conversation

lilin90
Copy link
Member

@lilin90 lilin90 commented Nov 7, 2024

What is changed, added or deleted? (Required)

  • Updates the wording in TOC.md and titles of several docs
  • Updates the cross-references in other files for wording consistency
  • Improves description for the relationship between TiDB and TiDB Operator

New TOC preview: https://pingcap-docsite-preview-git-preview-pi-6cb116-oreoxmts-projects.vercel.app/tidb/dev/

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

@lilin90 lilin90 added type/enhancement The issue or PR belongs to an enhancement. translation/doing This PR's assignee is translating this PR. labels Nov 7, 2024
@lilin90 lilin90 requested review from likidu and qiancai November 7, 2024 09:08
@lilin90 lilin90 self-assigned this Nov 7, 2024
@ti-chi-bot ti-chi-bot bot added area/develop This PR relates to the area of TiDB App development. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 7, 2024
@lilin90 lilin90 requested a review from Oreoxmt November 7, 2024 09:12
github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Nov 7, 2024
Copy link
Collaborator

Choose a reason for hiding this comment

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

github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Nov 8, 2024
@lilin90 lilin90 added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Nov 12, 2024
@@ -14,7 +14,7 @@ The TiDB Dashboard UI is built into the PD component for v4.0 or higher versions

See the following documents to learn how to deploy a standard TiDB cluster:

+ [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md)
+ [Quick Start with TiDB Self-Managed Using TiUP Playground](/quick-start-with-tidb.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Using -> using

Copy link
Member Author

Choose a reason for hiding this comment

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

We use the Chicago Style for titles, so let's keep it as "Using".

@likidu
Copy link
Collaborator

likidu commented Nov 14, 2024

@lilin90 A few small wording and URL comments, please see inline.

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Nov 15, 2024
Copy link

ti-chi-bot bot commented Nov 15, 2024

[LGTM Timeline notifier]

Timeline:

  • 2024-11-15 04:02:43.877376106 +0000 UTC m=+588126.068245095: ☑️ agreed by Oreoxmt.

@lilin90 lilin90 added the lgtm label Nov 15, 2024
@lilin90
Copy link
Member Author

lilin90 commented Nov 15, 2024

/approve

Copy link

ti-chi-bot bot commented Nov 15, 2024

[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 Nov 15, 2024
@ti-chi-bot ti-chi-bot bot merged commit 1204809 into pingcap:master Nov 15, 2024
9 checks passed
@lilin90 lilin90 deleted the update-toc-title-wording branch November 15, 2024 05:15
shhdgit added a commit that referenced this pull request Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved area/develop This PR relates to the area of TiDB App development. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/M Denotes a PR that changes 30-99 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.

3 participants