From 6fe0bb0ced8f799887152b5b39509787eb41e035 Mon Sep 17 00:00:00 2001 From: yikeke Date: Tue, 23 Jun 2020 18:19:35 +0800 Subject: [PATCH] add deprecated warnings for outdated deployment methods --- .markdownlint.yaml | 2 +- deploy-test-cluster-using-docker-compose.md | 8 ++++---- quick-start-with-tidb.md | 1 - test-deployment-using-docker.md | 10 +++++----- 4 files changed, 10 insertions(+), 11 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 178e1f7fd65b0..4ee86212623c4 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,4 +1,4 @@ -comment: 'Rules for PingCAP docs' +comment: 'Markdownlint Rules for PingCAP docs' # disable all by default default: false diff --git a/deploy-test-cluster-using-docker-compose.md b/deploy-test-cluster-using-docker-compose.md index 704c78587016f..67153f3dd69de 100644 --- a/deploy-test-cluster-using-docker-compose.md +++ b/deploy-test-cluster-using-docker-compose.md @@ -7,14 +7,14 @@ aliases: ['/docs/dev/how-to/get-started/deploy-tidb-from-docker-compose/'] # TiDB Docker Compose Deployment +> **Warning:** +> +> The Docker Compose deployment method provided in this document is no longer maintained. If you want to test TiDB, it is recommended to refer to [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md) for deployment. For **production environment**, **do not use** Docker Compose for deployment, but [deploy TiDB with TiUP](/production-deployment-using-tiup.md). + This document describes how to quickly deploy a TiDB testing cluster with a single command using [Docker Compose](https://docs.docker.com/compose/overview). With Docker Compose, you can use a YAML file to configure application services in multiple containers. Then, with a single command, you can create and start all the services from your configuration. -> **Warning:** -> -> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/production-deployment-using-tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production. - ## Prerequisites Make sure you have installed the following items on your machine: diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index c4fe38ebbe26a..8458a286d4cf5 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -2,7 +2,6 @@ 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. category: how-to -aliases: ['/docs/dev/test-deployment-using-docker/'] --- # Quick Start Guide for the TiDB Database Platform diff --git a/test-deployment-using-docker.md b/test-deployment-using-docker.md index d170a645cd374..004b074e5feba 100644 --- a/test-deployment-using-docker.md +++ b/test-deployment-using-docker.md @@ -7,13 +7,13 @@ aliases: ['/docs/dev/how-to/deploy/orchestrated/docker/'] # Deploy TiDB Using Docker -This page shows you how to manually deploy a multi-node TiDB cluster on multiple machines using Docker. - -To learn more, see [TiDB architecture](/architecture.md) and [Software and Hardware Recommendations](/hardware-and-software-requirements.md). - > **Warning:** > -> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/production-deployment-using-tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production. +> The Docker deployment method provided in this document is no longer maintained. If you want to test TiDB, it is recommended to refer to [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md) for deployment. For **production environment**, **do not use** Docker Compose for deployment, but [deploy TiDB with TiUP](/production-deployment-using-tiup.md). + +This document shows you how to manually deploy a multi-node TiDB cluster on multiple machines using Docker. + +To learn more, see [TiDB architecture](/architecture.md) and [Software and Hardware Recommendations](/hardware-and-software-requirements.md). ## Preparation