Merge remote-tracking branch 'upstream/master' into reuse-vector-sear…

…ch-docs
pingcap · Sep 18, 2024 · 868489b · 868489b
2 parents 3aa8797 + 7071b84
commit 868489b
Show file tree

Hide file tree

Showing 160 changed files with 909 additions and 768 deletions.
diff --git a/TOC.md b/TOC.md
@@ -2,8 +2,8 @@
 <!-- markdownlint-disable MD041 -->
 
 - [Docs Home](https://docs.pingcap.com/)
-- About TiDB
-  - [TiDB Introduction](/overview.md)
+- About TiDB Self-Managed
+  - [What is TiDB Self-Managed](/overview.md)
   - [TiDB 8.3 Release Notes](/releases/release-8.3.0.md)
   - [Features](/basic-features.md)
   - [MySQL Compatibility](/mysql-compatibility.md)
@@ -19,7 +19,7 @@
 - Develop
   - [Overview](/develop/dev-guide-overview.md)
   - Quick Start
-    - [Build a TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
+    - [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
     - [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md)
   - Example Applications
     - Java

diff --git a/_docHome.md b/_docHome.md
@@ -1,46 +1,54 @@
 ---
-title: PingCAP Documentation
+title: Home
 hide_sidebar: true
 hide_commit: true
 hide_leftNav: true
-summary: PingCAP Documentation provides how-to guides and references for using TiDB Cloud and TiDB, including data migration and application building. TiDB Cloud is a fully-managed Database-as-a-Service, offering easy access to the power of a cloud-native, distributed SQL database. TiDB is an open-source distributed SQL database with MySQL compatibility, horizontal scalability, and high availability. Developers can access documentation for application development and explore additional resources such as TiDB Playground, PingCAP Education, and community engagement opportunities.
+summary: TiDB Documentation provides how-to guides and references for using TiDB Cloud and TiDB Self-Managed, including data migration and application building. TiDB Cloud is a fully-managed Database-as-a-Service, offering easy access to the power of a cloud-native, distributed SQL database. TiDB is an open-source distributed SQL database with MySQL compatibility, horizontal scalability, and high availability. Developers can access documentation for application development and explore additional resources such as TiDB Playground, PingCAP Education, and community engagement opportunities.
 ---
 
-<DocHomeContainer title="PingCAP Documentation" subTitle="Explore the how-to guides and references you need to use TiDB Cloud and TiDB, migrate data, and build your applications on the database.">
+<DocHomeContainer title="TiDB Documentation" subTitle="Explore the how-to guides and references you need to use TiDB Cloud Serverless, TiDB Cloud Dedicated and TiDB Self-Managed, migrate data, and build your applications on the database." ctaLabel="Start TiDB Cloud Serverless for Free" ctaLink="https://tidbcloud.com/free-trial">
 
 <DocHomeSection label="TiDB Cloud" anchor="tidb-cloud" id="tidb-cloud">
 
 TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings everything great about TiDB to your cloud, letting you focus on your applications instead of the complexities of your database.
 
 <DocHomeCardContainer>
 
-<DocHomeCard href="https://docs.pingcap.com/tidbcloud" icon="doc2" label="TiDB Cloud Docs">
+<DocHomeCard href="/tidbcloud/tidb-cloud-intro" label="What is TiDB Cloud" icon="cloud-product-mauve">
 
-View the documentation for TiDB Cloud.
+Learn what TiDB Cloud is as an easy-to-use database and its key features.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart" icon="cloud5" label="Get Started with TiDB Cloud">
+<DocHomeCard href="/tidbcloud/tidb-cloud-quickstart" label="Get started with TiDB Cloud Serverless" icon="cloud-getstarted-mauve">
 
 Guide for an easy way to get started with TiDB Cloud.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://docs.pingcap.com/tidbcloud/tidb-cloud-poc" icon="cloud3" label="Perform a PoC with TiDB Cloud">
+<DocHomeCard href="/tidbcloud/dev-guide-overview" label="Developer Guide" icon="cloud-developer-mauve">
 
-Helps you quickly complete a Proof of Concept (PoC) with TiDB Cloud.
+Connect your application with the languages and frameworks you prefer.
 
 </DocHomeCard>
 
-</DocHomeCardContainer>
+<DocHomeCard href="/tidbcloud/vector-search-overview" label="Vector Search in TiDB Cloud Serverless (Beta)" icon="cloud-vector-mauve">
+
+Explore native support of Vector Search in TiDB Cloud Serverless to build your AI application.
+
+</DocHomeCard>
+
+<DocHomeCard href="/tidbcloud/tidb-cloud-roadmap" label="TiDB Cloud Roadmap" icon="cloud-roadmap-mauve">
+
+Planned features and releases for TiDB Cloud.
 
-Get the power of a cloud-native, distributed SQL database built for real-time analytics in a fully-managed service.
+</DocHomeCard>
 
-<a href="https://tidbcloud.com/free-trial" class="button" target="_blank" referrerpolicy="no-referrer-when-downgrade">Try Free</a>
+</DocHomeCardContainer>
 
 </DocHomeSection>
 
-<DocHomeSection label="TiDB" anchor="tidb" id="tidb">
+<DocHomeSection label="TiDB Self-Managed" anchor="tidb-self-managed" id="tidb-self-managed">
 
 <!-- Localization note for TiDB:
 
@@ -50,111 +58,101 @@ Get the power of a cloud-native, distributed SQL database built for real-time an
 
 -->
 
-TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability. You can deploy TiDB in a self-hosted environment or in the cloud.
+TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability. You can deploy TiDB in a self-hosted environment or on the cloud.
 
 <DocHomeCardContainer>
 
-<DocHomeCard href="https://docs.pingcap.com/tidb/stable" icon="doc1" label="TiDB Docs">
+<DocHomeCard href="/tidb/stable/overview" label="What is TiDB Self-Managed" icon="oss-product-blue">
 
-View the documentation for TiDB.
+Learn what is TiDB Self-Managed and its key features.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://docs.pingcap.com/tidb/stable/quick-start-with-tidb" icon="doc5" label="Get Started with TiDB">
+<DocHomeCard href="/tidb/stable/quick-start-with-tidb" label="Get started with TiDB Self-Managed" icon="oss-getstarted-blue">
 
-Walks you through the quickest way to get started with TiDB.
+Walks you through the quickest way to get started with TiDB Self-Managed.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://docs.pingcap.com/tidb/stable/production-deployment-using-tiup" icon="cloud7" label="Deploy a Local TiDB Cluster">
+<DocHomeCard href="/tidb/stable/production-deployment-using-tiup" label="Deploy a Local TiDB Cluster" icon="oss-deploy-blue">
 
 Learn how to deploy TiDB locally in a production environment.
 
 </DocHomeCard>
 
-</DocHomeCardContainer>
-
-The open-source TiDB platform is released under the Apache 2.0 license and is supported by the community.
-
-<a href="https://github.com/pingcap/tidb" class="button" target="_blank" referrerpolicy="no-referrer-when-downgrade">View on GitHub</a>
-
-</DocHomeSection>
+<DocHomeCard href="/tidb/stable/dev-guide-overview" label="Developer Guide" icon="oss-developer-blue">
 
-<DocHomeSection label="Developers" anchor="developers" id="developers">
+For application developers using TiDB Self-Managed.
 
-<DocHomeCardContainer>
+</DocHomeCard>
 
-<DocHomeCard href="https://docs.pingcap.com/tidb/stable/dev-guide-overview" icon="doc8" label="Developer Guide">
+<DocHomeCard href="/tidb/stable/mysql-compatibility" label="MySQL Compatibility" icon="oss-mysql-blue">
 
-Documentation for TiDB application developers.
+TiDB is highly compatible with the MySQL protocol and the common features and syntax of MySQL 5.7 and MySQL 8.0.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://docs.pingcap.com/tidbcloud/dev-guide-overview" icon="cloud-dev" label="Developer Guide">
+<DocHomeCard href="/tidb/dev/tidb-roadmap" label="TiDB Self-Managed Roadmap" icon="oss-roadmap-blue">
 
-Documentation for TiDB Cloud application developers.
+Planned features and release dates for TiDB Self-Managed.
 
 </DocHomeCard>
 
 </DocHomeCardContainer>
 
+The open-source TiDB platform is released under the Apache 2.0 license and is supported by the community. [View on GitHub](https://github.com/pingcap/tidb)
+
 </DocHomeSection>
 
-<DocHomeSection label="More resources" anchor="resources" id="resources">
+<DocHomeSection label="More Resources" anchor="resources" id="resources">
 
 <DocHomeCardContainer>
 
-<DocHomeCard href="https://play.tidbcloud.com/?utm_source=docs&utm_medium=home_more_resources" icon="playground" label="TiDB Playground">
+<DocHomeCard href="https://www.pingcap.com/education/" label="Learning Center" icon="global-tidb-education">
 
-Experience the capabilities of TiDB WITHOUT registration.
+Learn TiDB Cloud and TiDB Self-Managed through well-designed online courses and instructor-led training.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://www.pingcap.com/education/" icon="cloud1" label="PingCAP Education">
+<DocHomeCard href="https://www.pingcap.com/blog/" label="Blog" icon="global-tidb-blog">
 
-Learn TiDB and TiDB Cloud through well-designed online courses and instructor-led training.
+Read great articles about TiDB Cloud and TiDB Self-Managed.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://ask.pingcap.com?utm_source=doc" icon="doc9" label="Community">
+<DocHomeCard href="https://www.pingcap.com/event/" label="Events" icon="global-tidb-events">
 
-Connect with other TiDB users on TiDB Community for sharing and learning.
+Learn about events hosted by PingCAP and the community.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://www.pingcap.com/blog/" icon="doc10" label="Blog Posts">
+<DocHomeCard href="https://www.pingcap.com/ebook-whitepaper/" label="eBooks & Papers" icon="global-tidb-ebook">
 
-Read great articles about TiDB and TiDB Cloud.
+Download eBooks and papers.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://www.pingcap.com/videos/" icon="doc11" label="Videos">
+<DocHomeCard href="https://www.pingcap.com/videos/" label="Videos" icon="global-tidb-video">
 
 Watch a compilation of short videos describing TiDB and various use cases.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://www.pingcap.com/event/" icon="events" label="Events">
+<DocHomeCard href="https://ossinsight.io/" label="OSS Insight" icon="global-tidb-ossinsight">
 
-Learn about events hosted by PingCAP and the community.
-
-</DocHomeCard>
-
-<DocHomeCard href="https://www.pingcap.com/ebook-whitepaper/" icon="papers" label="eBooks & Papers">
-
-Download eBooks and papers.
+A powerful insight tool that provides in-depth analysis of any GitHub repository, powered by TiDB Cloud.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://ossinsight.io/" icon="ossinsight" label="OSS Insight">
+<DocHomeCard href="https://play.tidbcloud.com/?utm_source=docs&utm_medium=home_more_resources" label="Playground" icon="global-tidb-playground">
 
-A powerful insight tool that analyzes any GitHub repository in depth, powered by TiDB Cloud.
+Experience the capabilities of TiDB without registration.
 
 </DocHomeCard>
 
-<DocHomeCard href="https://github.com/pingcap/docs/blob/master/CONTRIBUTING.md" icon="contributor" label="Contribute">
+<DocHomeCard href="https://discord.gg/DQZ2dy3cuc?utm_source=doc" label="Join our community on Discord" icon="global-tidb-discord" colspan="2" actionBtnLabel="Join Community" ctaGraphic="global-iso-hand">
 
-Let's work together to improve the documentation!
+Join us on Discord or become a contributor.
 
 </DocHomeCard>
 

diff --git a/_index.md b/_index.md
@@ -1,12 +1,12 @@
 ---
-title: TiDB Introduction
-aliases: ["/docs/dev/", "/docs/dev/adopters/", "/tidb/dev/adopters"]
+title: TiDB Self-Managed
+aliases: ['/docs/dev/', '/docs/dev/adopters/', '/tidb/dev/adopters']
 hide_sidebar: true
 hide_commit: true
 summary: TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. The guide provides information on features, TiFlash, development, deployment, migration, maintenance, monitoring, tuning, tools, and references. It covers everything from quick start to advanced configurations and tools for TiDB.
 ---
 
-<LearningPathContainer platform="tidb" title="TiDB" subTitle="TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. Find the guide, samples, and references you need to use TiDB.">
+<LearningPathContainer platform="tidb" title="TiDB Self-Managed" subTitle="TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. Find the guide, samples, and references you need to use TiDB.">
 
 <!-- Localization note for TiDB:
 
@@ -18,7 +18,7 @@ summary: TiDB is an open-source distributed SQL database that supports Hybrid Tr
 
 <LearningPath label="Learn" icon="cloud1">
 
-[What is TiDB](https://docs.pingcap.com/tidb/dev/overview)
+[What is TiDB Self-Managed](https://docs.pingcap.com/tidb/dev/overview)
 
 [Features](https://docs.pingcap.com/tidb/dev/basic-features)
 
@@ -28,7 +28,7 @@ summary: TiDB is an open-source distributed SQL database that supports Hybrid Tr
 
 <LearningPath label="Try" icon="cloud5">
 
-[Try Out TiDB](https://docs.pingcap.com/tidb/dev/quick-start-with-tidb)
+[Try Out TiDB Self-Managed](https://docs.pingcap.com/tidb/dev/quick-start-with-tidb)
 
 [Try Out HTAP](https://docs.pingcap.com/tidb/dev/quick-start-with-htap)
 

diff --git a/br/br-pitr-guide.md b/br/br-pitr-guide.md
@@ -128,7 +128,7 @@ Testing scenario 1 (on [TiDB Cloud](https://tidbcloud.com)) is as follows:
 - New log data created in the cluster: 10 GB/h
 - Write (INSERT/UPDATE/DELETE) QPS: 10,000
 
-Testing scenario 2 (on TiDB Self-Hosted) is as follows:
+Testing scenario 2 (on TiDB Self-Managed) is as follows:
 
 - The number of TiKV nodes (8 core, 64 GB memory): 6
 - TiKV configuration item `import.num-threads`: 8

diff --git a/dashboard/dashboard-access.md b/dashboard/dashboard-access.md
@@ -34,13 +34,12 @@ You can use TiDB Dashboard in the following common desktop browsers of a relativ
 
 ## Sign in
 
-After accessing TiDB Dashboard, you will be directed to the user login interface, as shown in the image below.
+After accessing TiDB Dashboard, you will be directed to the user login interface.
 
 - You can sign in to TiDB Dashboard using the TiDB `root` account.
+- You can also sign in to TiDB Dashboard via Single Sign-On (SSO). For more information, see [Configure SSO for TiDB Dashboard](/dashboard/dashboard-session-sso.md).
 - If you have created a [User-defined SQL User](/dashboard/dashboard-user.md), you can sign in using this account and the corresponding password.
 
-![Login interface](/media/dashboard/dashboard-access-login.png)
-
 If one of the following situations exists, the login might fail:
 
 - TiDB `root` user does not exist.