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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

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

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 self-assigned this Nov 7, 2024
@ti-chi-bot ti-chi-bot bot added the area/develop This PR relates to the area of TiDB App development. label Nov 7, 2024
Copy link

ti-chi-bot bot commented Nov 7, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from lilin90, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label 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.

@@ -1,6 +1,6 @@
---
title: Deploy a TiDB Cluster Using TiUP
summary: Learn how to easily deploy a TiDB cluster using TiUP.
summary: Learn how to easily Deploy a TiDB Cluster Using TiUP.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
summary: Learn how to easily Deploy a TiDB Cluster Using TiUP.
summary: Learn how to easily deploy a TiDB cluster using TiUP.

Use sentence case in metadata

@@ -1,12 +1,12 @@
---
title: Quick Start Guide for the TiDB Database Platform
title: Quick Start with TiDB Self-Managed Using TiUP Playground
summary: Learn how to quickly get started with the TiDB platform and see if TiDB is the right choice for you.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
summary: Learn how to quickly get started with the TiDB platform and see if TiDB is the right choice for you.
summary: Learn how to quickly get started with TiDB Self-Managed using TiUP playground and see if TiDB is the right choice for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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. translation/doing This PR's assignee is translating this PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants