-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sync the scaffold from pingcap/docs-staging@fa0fff5
- Loading branch information
Docsite Preview Bot
committed
Dec 16, 2024
1 parent
7d5dadd
commit 9a25b62
Showing
11 changed files
with
3,188 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| --- | ||
| title: Home | ||
| hide_sidebar: true | ||
| hide_commit: true | ||
| hide_leftNav: true | ||
| 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="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="/tidbcloud/tidb-cloud-intro" label="What is TiDB Cloud" icon="cloud-product-mauve"> | ||
|
|
||
| Learn what TiDB Cloud is as an easy-to-use database and its key features. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <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="/tidbcloud/dev-guide-overview" label="Developer Guide" icon="cloud-developer-mauve"> | ||
|
|
||
| Connect your application with the languages and frameworks you prefer. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <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. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| </DocHomeCardContainer> | ||
|
|
||
| </DocHomeSection> | ||
|
|
||
| <DocHomeSection label="TiDB Self-Managed" anchor="tidb-self-managed" id="tidb-self-managed"> | ||
|
|
||
| <!-- Localization note for TiDB: | ||
| - English: use distributed SQL, and start to emphasize HTAP | ||
| - Chinese: can keep "NewSQL" and emphasize one-stop real-time HTAP ("一栈式实时 HTAP") | ||
| - Japanese: use NewSQL because it is well-recognized | ||
| --> | ||
|
|
||
| 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="/tidb/stable/overview" label="What is TiDB Self-Managed" icon="oss-product-blue"> | ||
|
|
||
| Learn what is TiDB Self-Managed and its key features. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <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 Self-Managed. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <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> | ||
|
|
||
| <DocHomeCard href="/tidb/stable/dev-guide-overview" label="Developer Guide" icon="oss-developer-blue"> | ||
|
|
||
| For application developers using TiDB Self-Managed. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <DocHomeCard href="/tidb/stable/mysql-compatibility" label="MySQL Compatibility" icon="oss-mysql-blue"> | ||
|
|
||
| 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="/tidb/dev/tidb-roadmap" label="TiDB Self-Managed Roadmap" icon="oss-roadmap-blue"> | ||
|
|
||
| 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"> | ||
|
|
||
| <DocHomeCardContainer> | ||
|
|
||
| <DocHomeCard href="https://www.pingcap.com/education/" label="Learning Center" icon="global-tidb-education"> | ||
|
|
||
| Learn TiDB Cloud and TiDB Self-Managed through well-designed online courses and instructor-led training. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <DocHomeCard href="https://www.pingcap.com/blog/" label="Blog" icon="global-tidb-blog"> | ||
|
|
||
| Read great articles about TiDB Cloud and TiDB Self-Managed. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <DocHomeCard href="https://www.pingcap.com/event/" label="Events" icon="global-tidb-events"> | ||
|
|
||
| Learn about events hosted by PingCAP and the community. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <DocHomeCard href="https://www.pingcap.com/ebook-whitepaper/" label="eBooks & Papers" icon="global-tidb-ebook"> | ||
|
|
||
| Download eBooks and papers. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <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://ossinsight.io/" label="OSS Insight" icon="global-tidb-ossinsight"> | ||
|
|
||
| A powerful insight tool that provides in-depth analysis of any GitHub repository, powered by TiDB Cloud. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <DocHomeCard href="https://play.tidbcloud.com/?utm_source=docs&utm_medium=home_more_resources" label="Playground" icon="global-tidb-playground"> | ||
|
|
||
| Experience the capabilities of TiDB without registration. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| <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"> | ||
|
|
||
| Join us on Discord or become a contributor. | ||
|
|
||
| </DocHomeCard> | ||
|
|
||
| </DocHomeCardContainer> | ||
|
|
||
| </DocHomeSection> | ||
|
|
||
| </DocHomeContainer> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| --- | ||
| title: TiDB Self-Managed | ||
| 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 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: | ||
| - English: use distributed SQL, and start to emphasize HTAP | ||
| - Chinese: can keep "NewSQL" and emphasize one-stop real-time HTAP ("一栈式实时 HTAP") | ||
| - Japanese: use NewSQL because it is well-recognized | ||
| --> | ||
|
|
||
| <LearningPath label="Learn" icon="cloud1"> | ||
|
|
||
| [What is TiDB Self-Managed](https://docs.pingcap.com/tidb/v8.5/overview) | ||
|
|
||
| [Features](https://docs.pingcap.com/tidb/v8.5/basic-features) | ||
|
|
||
| [TiFlash](https://docs.pingcap.com/tidb/v8.5/tiflash-overview) | ||
|
|
||
| </LearningPath> | ||
|
|
||
| <LearningPath label="Try" icon="cloud5"> | ||
|
|
||
| [Try Out TiDB Self-Managed](https://docs.pingcap.com/tidb/v8.5/quick-start-with-tidb) | ||
|
|
||
| [Try Out HTAP](https://docs.pingcap.com/tidb/v8.5/quick-start-with-htap) | ||
|
|
||
| [Import Example Database](https://docs.pingcap.com/tidb/v8.5/import-example-data) | ||
|
|
||
| </LearningPath> | ||
|
|
||
| <LearningPath label="Develop" icon="doc8"> | ||
|
|
||
| [Developer Guide Overview](https://docs.pingcap.com/tidb/v8.5/dev-guide-overview) | ||
|
|
||
| [Quick Start](https://docs.pingcap.com/tidb/v8.5/dev-guide-build-cluster-in-cloud) | ||
|
|
||
| [Example Application](https://docs.pingcap.com/tidb/v8.5/dev-guide-sample-application-java-spring-boot) | ||
|
|
||
| </LearningPath> | ||
|
|
||
| <LearningPath label="Deploy" icon="deploy"> | ||
|
|
||
| [Software and Hardware Requirements](https://docs.pingcap.com/tidb/v8.5/hardware-and-software-requirements) | ||
|
|
||
| [Deploy a TiDB Cluster Using TiUP](https://docs.pingcap.com/tidb/v8.5/production-deployment-using-tiup) | ||
|
|
||
| [Deploy a TiDB Cluster on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable) | ||
|
|
||
| </LearningPath> | ||
|
|
||
| <LearningPath label="Migrate" icon="cloud3"> | ||
|
|
||
| [Migration Overview](https://docs.pingcap.com/tidb/v8.5/migration-overview) | ||
|
|
||
| [Migration Tools](https://docs.pingcap.com/tidb/v8.5/migration-tools) | ||
|
|
||
| [Typical Scenarios](https://docs.pingcap.com/tidb/v8.5/migrate-aurora-to-tidb) | ||
|
|
||
| </LearningPath> | ||
|
|
||
| <LearningPath label="Maintain" icon="maintain"> | ||
|
|
||
| [Upgrade a Cluster](https://docs.pingcap.com/tidb/v8.5/upgrade-tidb-using-tiup) | ||
|
|
||
| [Scale a Cluster](https://docs.pingcap.com/tidb/v8.5/scale-tidb-using-tiup) | ||
|
|
||
| [Back Up and Restore Cluster Data](https://docs.pingcap.com/tidb/v8.5/backup-and-restore-overview) | ||
|
|
||
| [Daily Check](https://docs.pingcap.com/tidb/v8.5/daily-check) | ||
|
|
||
| [Maintain TiDB Using TiUP](https://docs.pingcap.com/tidb/v8.5/maintain-tidb-using-tiup) | ||
|
|
||
| </LearningPath> | ||
|
|
||
| <LearningPath label="Monitor" icon="cloud6"> | ||
|
|
||
| [Use Prometheus and Grafana](https://docs.pingcap.com/tidb/v8.5/tidb-monitoring-framework) | ||
|
|
||
| [Monitoring API](https://docs.pingcap.com/tidb/v8.5/tidb-monitoring-api) | ||
|
|
||
| [Alert Rules](https://docs.pingcap.com/tidb/v8.5/alert-rules) | ||
|
|
||
| </LearningPath> | ||
|
|
||
| <LearningPath label="Tune" icon="tidb-cloud-tune"> | ||
|
|
||
| [Tuning Overview](https://docs.pingcap.com/tidb/v8.5/performance-tuning-overview) | ||
|
|
||
| [Tuning Methods](https://docs.pingcap.com/tidb/v8.5/performance-tuning-methods) | ||
|
|
||
| [Tune OLTP Performance](https://docs.pingcap.com/tidb/v8.5/performance-tuning-practices) | ||
|
|
||
| [Tune Operating System](https://docs.pingcap.com/tidb/v8.5/tune-operating-system) | ||
|
|
||
| [Tune Configurations](https://docs.pingcap.com/tidb/v8.5/configure-memory-usage) | ||
|
|
||
| [Tune SQL Performance](https://docs.pingcap.com/tidb/v8.5/sql-tuning-overview) | ||
|
|
||
| </LearningPath> | ||
|
|
||
| <LearningPath label="Tools" icon="doc7"> | ||
|
|
||
| [TiUP](https://docs.pingcap.com/tidb/v8.5/tiup-overview) | ||
|
|
||
| [TiDB Operator](https://docs.pingcap.com/tidb/v8.5/tidb-operator-overview) | ||
|
|
||
| [TiDB Data Migration (DM)](https://docs.pingcap.com/tidb/v8.5/dm-overview) | ||
|
|
||
| [TiDB Lightning](https://docs.pingcap.com/tidb/v8.5/tidb-lightning-overview) | ||
|
|
||
| [Dumpling](https://docs.pingcap.com/tidb/v8.5/dumpling-overview) | ||
|
|
||
| [TiCDC](https://docs.pingcap.com/tidb/v8.5/ticdc-overview) | ||
|
|
||
| [Backup & Restore (BR)](https://docs.pingcap.com/tidb/v8.5/backup-and-restore-overview) | ||
|
|
||
| [PingCAP Clinic](https://docs.pingcap.com/tidb/v8.5/clinic-introduction) | ||
|
|
||
| </LearningPath> | ||
|
|
||
| <LearningPath label="Reference" icon="cloud-dev"> | ||
|
|
||
| [TiDB Roadmap](https://docs.pingcap.com/tidb/dev/tidb-roadmap) | ||
|
|
||
| [TiDB Configuration File Parameters](https://docs.pingcap.com/tidb/v8.5/tidb-configuration-file) | ||
|
|
||
| [TiDB Command-line Flags](https://docs.pingcap.com/tidb/v8.5/command-line-flags-for-tidb-configuration) | ||
|
|
||
| [TiDB Control](https://docs.pingcap.com/tidb/v8.5/tidb-control) | ||
|
|
||
| [System Variables](https://docs.pingcap.com/tidb/v8.5/system-variables) | ||
|
|
||
| [Release Notes](https://docs.pingcap.com/tidb/v8.5/release-notes) | ||
|
|
||
| [FAQ Summary](https://docs.pingcap.com/tidb/v8.5/faq-overview) | ||
|
|
||
| </LearningPath> | ||
|
|
||
| </LearningPathContainer> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.