Skip to content

Commit

Permalink
*: update TOC and title wording for on-boarding docs (#19353)
Browse files Browse the repository at this point in the history
  • Loading branch information
lilin90 authored Nov 15, 2024
1 parent 85e27f3 commit 1204809
Show file tree
Hide file tree
Showing 13 changed files with 24 additions and 25 deletions.
11 changes: 5 additions & 6 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
- [TiDB Limitations](/tidb-limitations.md)
- [Credits](/credits.md)
- [Roadmap](/tidb-roadmap.md)
- Quick Start
- [Try Out TiDB](/quick-start-with-tidb.md)
- [Try Out HTAP](/quick-start-with-htap.md)
- Get Started
- [Quick Start with TiDB](/quick-start-with-tidb.md)
- [Quick Start with HTAP](/quick-start-with-htap.md)
- [Learn TiDB SQL](/basic-sql-operations.md)
- [Learn HTAP](/explore-htap.md)
- [Import Example Database](/import-example-data.md)
Expand Down Expand Up @@ -140,9 +140,8 @@
- [TiSpark Topology](/tispark-deployment-topology.md)
- [Cross-DC Topology](/geo-distributed-deployment-topology.md)
- [Hybrid Topology](/hybrid-deployment-topology.md)
- Install and Start
- [Use TiUP](/production-deployment-using-tiup.md)
- [Deploy on Kubernetes](/tidb-in-kubernetes.md)
- [Deploy Using TiUP](/production-deployment-using-tiup.md)
- [Deploy on Kubernetes](/tidb-in-kubernetes.md)
- [Verify Cluster Status](/post-installation-check.md)
- Test Cluster Performance
- [Test TiDB Using Sysbench](/benchmark/benchmark-tidb-using-sysbench.md)
Expand Down
2 changes: 1 addition & 1 deletion dashboard/dashboard-ops-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](/quick-start-with-tidb.md)
+ [Deploy TiDB in Production Environment](/production-deployment-using-tiup.md)
+ [Kubernetes environment deployment](https://docs.pingcap.com/tidb-in-kubernetes/stable/access-dashboard)

Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-create-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ In this scenario, TiDB, an **HTAP (Hybrid Transactional and Analytical Processin

Currently, TiDB supports two data analysis engines, **TiFlash** and **TiSpark**. For the large data scenarios (100 T), **TiFlash MPP** is recommended as the primary solution for HTAP, and **TiSpark** as a complementary solution.

To learn more about TiDB HTAP capabilities, refer to the following documents: [Quick Start Guide for TiDB HTAP](/quick-start-with-htap.md) and [Explore HTAP](/explore-htap.md).
To learn more about TiDB HTAP capabilities, refer to the following documents: [Quick Start with TiDB HTAP](/quick-start-with-htap.md) and [Explore HTAP](/explore-htap.md).

</CustomContent>

Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-hybrid-oltp-and-olap-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ For more information about how TiDB chooses to use TiFlash, see [Use TiDB to rea

<CustomContent platform="tidb">

- [Quick Start with HTAP](/quick-start-with-htap.md)
- [Quick Start with TiDB HTAP](/quick-start-with-htap.md)
- [Explore HTAP](/explore-htap.md)

</CustomContent>
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This guide is written for application developers, but if you are interested in t

This tutorial shows how to quickly build an application using TiDB, the possible use cases of TiDB and how to handle common problems.

Before reading this page, it is recommended that you read the [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md).
Before reading this page, it is recommended that you read the [Quick Start with TiDB Self-Managed](/quick-start-with-tidb.md).

</CustomContent>

Expand Down
4 changes: 2 additions & 2 deletions explore-htap.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This guide describes how to explore and use the features of TiDB Hybrid Transact

> **Note:**
>
> If you are new to TiDB HTAP and want to start using it quickly, see [Quick start with HTAP](/quick-start-with-htap.md).
> If you are new to TiDB HTAP and want to start using it quickly, see [Quick Start with TiDB HTAP](/quick-start-with-htap.md).
## Use cases

Expand Down Expand Up @@ -62,7 +62,7 @@ Before exploring the features of TiDB HTAP, you need to deploy TiDB and the corr
- TiFlash

- If you have deployed a TiDB cluster with no TiFlash node, add the TiFlash nodes in the current TiDB cluster. For detailed information, see [Scale out a TiFlash cluster](/scale-tidb-using-tiup.md#scale-out-a-tiflash-cluster).
- If you have not deployed a TiDB cluster, see [Deploy a TiDB Cluster using TiUP](/production-deployment-using-tiup.md). Based on the minimal TiDB topology, you also need to deploy the [topology of TiFlash](/tiflash-deployment-topology.md).
- If you have not deployed a TiDB cluster, see [Deploy a TiDB Cluster Using TiUP](/production-deployment-using-tiup.md). Based on the minimal TiDB topology, you also need to deploy the [topology of TiFlash](/tiflash-deployment-topology.md).
- When deciding how to choose the number of TiFlash nodes, consider the following scenarios:

- If your use case requires OLTP with small-scale analytical processing and Ad-Hoc queries, deploy one or several TiFlash nodes. They can dramatically increase the speed of analytic queries.
Expand Down
2 changes: 1 addition & 1 deletion get-started-with-tidb-lightning.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ First, you can use [dumpling](/dumpling-overview.md) to export data from MySQL.
Before starting the data import, you need to deploy a TiDB cluster for the import. If you already have a TiDB cluster, you can skip this step.
For the steps on deploying a TiDB cluster, refer to the [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md).
For the steps on deploying a TiDB cluster, refer to the [Quick Start with TiDB Self-Managed](/quick-start-with-tidb.md).
## Step 3: Install TiDB Lightning
Expand Down
6 changes: 3 additions & 3 deletions quick-start-with-htap.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Quick start with HTAP
title: Quick Start with TiDB HTAP
summary: Learn how to quickly get started with the TiDB HTAP.
---

# Quick Start Guide for TiDB HTAP
# Quick Start with TiDB HTAP

This guide walks you through the quickest way to get started with TiDB's one-stop solution of Hybrid Transactional and Analytical Processing (HTAP).

Expand All @@ -26,7 +26,7 @@ In this document, you can experience the convenience and high performance of TiD

### Step 1. Deploy a local test environment

Before using TiDB HTAP, follow the steps in the [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md) to prepare a local test environment, and run the following command to deploy a TiDB cluster:
Before using TiDB HTAP, follow the steps in the [Quick Start with TiDB Self-Managed](/quick-start-with-tidb.md) to prepare a local test environment, and run the following command to deploy a TiDB cluster:

{{< copyable "shell-regular" >}}

Expand Down
8 changes: 4 additions & 4 deletions quick-start-with-tidb.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Quick Start Guide for the TiDB Database Platform
summary: Learn how to quickly get started with the TiDB platform and see if TiDB is the right choice for you.
title: Quick Start with TiDB Self-Managed
summary: Learn how to quickly get started with TiDB Self-Managed using TiUP playground and see if TiDB is the right choice for you.
aliases: ['/docs/dev/quick-start-with-tidb/','/docs/dev/test-deployment-using-docker/']
---

# Quick Start Guide for the TiDB Database Platform
# Quick Start with TiDB Self-Managed

This guide provides the quickest way to get started with TiDB. For non-production environments, you can deploy your TiDB database using either of the following methods:
This guide provides the quickest way to get started with TiDB Self-Managed. For non-production environments, you can deploy your TiDB database using either of the following methods:

- [Deploy a local test cluster](#deploy-a-local-test-cluster) (for macOS and Linux)
- [Simulate production deployment on a single machine](#simulate-production-deployment-on-a-single-machine) (for Linux only)
Expand Down
2 changes: 1 addition & 1 deletion resources/doc-templates/template-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ summary: Summarize this doc in 115 to 145 characters. Start with an SEO-friendly

> About this template:
>
> - This document is a template for task topics, which tells users how to perform a specific task step by step. You can directly copy and use this template and delete unnecessary annotations. An example of this type of document: [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md)
> - This document is a template for task topics, which tells users how to perform a specific task step by step. You can directly copy and use this template and delete unnecessary annotations. An example of this type of document: [Quick Start with TiDB Self-Managed](/quick-start-with-tidb.md)
> - For a new document, please add a link to the appropriate location in the `TOC.md` file (consider where users are most likely to look for this document in the table of contents).
> - The headings within the document cannot skip levels, and try to avoid using level 5 headings.
Expand Down
2 changes: 1 addition & 1 deletion ticdc/ticdc-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The expected output is as follows:
## How to verify if TiCDC has replicated all updates after upstream stops updating?

After the upstream TiDB cluster stops updating, you can verify if replication is complete by comparing the latest [TSO](/glossary.md#tso) timestamp of the upstream TiDB cluster with the replication progress in TiCDC. If the TiCDC replication progress timestamp is greater than or equal to the upstream TiDB cluster's TSO, then all updates have been replicated. To verify replication completeness, perform the following steps:
After the upstream TiDB cluster stops updating, you can verify if replication is complete by comparing the latest [TSO](/glossary.md#timestamp-oracle-tso) timestamp of the upstream TiDB cluster with the replication progress in TiCDC. If the TiCDC replication progress timestamp is greater than or equal to the upstream TiDB cluster's TSO, then all updates have been replicated. To verify replication completeness, perform the following steps:

1. Get the latest TSO timestamp from the upstream TiDB cluster.

Expand Down
2 changes: 1 addition & 1 deletion tidb-in-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ aliases: ['/docs/tidb-in-kubernetes/dev/']

You can use [TiDB Operator](https://github.com/pingcap/tidb-operator) to deploy TiDB clusters on Kubernetes. TiDB Operator is an automatic operation system for TiDB clusters on Kubernetes. It provides full life-cycle management for TiDB including deployment, upgrades, scaling, backup, fail-over, and configuration changes. With TiDB Operator, TiDB can run seamlessly in the Kubernetes clusters deployed on a public or private cloud.

Currently, the TiDB on Kubernetes documentation is independent of the TiDB documentation. For detailed steps on how to deploy TiDB clusters on Kubernetes using TiDB Operator, see [TiDB on Kubernetes documentation](https://docs.pingcap.com/tidb-in-kubernetes/stable/).
Currently, the TiDB on Kubernetes documentation is independent of the TiDB documentation. For detailed steps on how to deploy TiDB clusters on Kubernetes using TiDB Operator, learn the [relationship between TiDB Operator and TiDB versions](https://docs.pingcap.com/tidb-in-kubernetes/stable/tidb-operator-overview), and see the corresponding [TiDB on Kubernetes documentation](https://docs.pingcap.com/tidb-in-kubernetes/stable/).
4 changes: 2 additions & 2 deletions tiflash/tiflash-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,15 @@ You can use TiDB to read TiFlash replicas for analytical processing. See the fol

<CustomContent platform="tidb">

To experience the whole process from importing data to querying in a TPC-H dataset, refer to [Quick Start Guide for TiDB HTAP](/quick-start-with-htap.md).
To experience the whole process from importing data to querying in a TPC-H dataset, refer to [Quick Start with TiDB HTAP](/quick-start-with-htap.md).

</CustomContent>

## See also

<CustomContent platform="tidb">

- To deploy a new cluster with TiFlash nodes, see [Deploy a TiDB cluster using TiUP](/production-deployment-using-tiup.md).
- To deploy a new cluster with TiFlash nodes, see [Deploy a TiDB Cluster Using TiUP](/production-deployment-using-tiup.md).
- To add a TiFlash node in a deployed cluster, see [Scale out a TiFlash cluster](/scale-tidb-using-tiup.md#scale-out-a-tiflash-cluster).
- [Maintain a TiFlash cluster](/tiflash/maintain-tiflash.md).
- [Tune TiFlash performance](/tiflash/tune-tiflash-performance.md).
Expand Down

0 comments on commit 1204809

Please sign in to comment.