en: update config; update api reference link (#476)

* en: update config; update api reference link * fix a wrong link
pingcap · Jun 29, 2020 · df4bda0 · df4bda0
1 parent 0567dac
commit df4bda0
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 14,139 deletions.
diff --git a/en/api-references.md b/en/api-references.md
diff --git a/en/configure-a-tidb-cluster.md b/en/configure-a-tidb-cluster.md
@@ -25,7 +25,7 @@ If you are using a NUMA-based CPU, you need to enable `Static`'s CPU management
 
 ## Configure TiDB deployment
 
-To configure a TiDB deployment, you need to configure the `TiDBCluster` CR. Refer to the [TidbCluster example](https://github.com/pingcap/tidb-operator/blob/master/examples/tiflash/tidb-cluster.yaml) for an example. For the complete configurations of `TiDBCluster` CR, refer to [API documentation](https://github.com/pingcap/docs-tidb-operator/blob/master/en/api-references.md).
+To configure a TiDB deployment, you need to configure the `TiDBCluster` CR. Refer to the [TidbCluster example](https://github.com/pingcap/tidb-operator/blob/master/examples/tiflash/tidb-cluster.yaml) for an example. For the complete configurations of `TiDBCluster` CR, refer to [API documentation](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md).
 
 > **Note:**
 >
@@ -178,8 +178,8 @@ spec:
   tikv:
     image: pingcap.com/tikv:v4.0.0
     config:
-      grpc-concurrenc: 4
-      sync-log: true
+      log-level: "info"
+      slow-log-threshold: "1s"
     replicas: 1
     requests:
       cpu: 2
@@ -207,8 +207,8 @@ spec:
   pd:
     image: pingcap.com/pd:v4.0.0
     config:
-      format: "format"
-      disable-timestamp: false
+      lease: 3
+      enable-prevote: true
 ```
 
 For all the configurable parameters of PD, refer to [PD Configuration File](https://pingcap.com/docs/stable/reference/configuration/pd-server/configuration-file/).

diff --git a/en/deploy-on-alibaba-cloud.md b/en/deploy-on-alibaba-cloud.md
@@ -170,7 +170,7 @@ All the instances except ACK mandatory workers are deployed across availability
     cp manifests/db.yaml.example db.yaml && cp manifests/db-monitor.yaml.example db-monitor.yaml
     ```
 
-    To complete the CR file configuration, refer to [TiDB Operator API documentation](api-references.md) and [Configuring TiDB Cluster](configure-a-tidb-cluster.md).
+    To complete the CR file configuration, refer to [TiDB Operator API documentation](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md) and [Configuring TiDB Cluster](configure-a-tidb-cluster.md).
 
     * To deploy TiFlash, configure `spec.tiflash` in `db.yaml` as follows:
 
@@ -319,7 +319,7 @@ In the default configuration, the Terraform script creates a new VPC. To use the
 
 ### Configure the TiDB cluster
 
-See [TiDB Operator API Documentation](api-references.md) and [Configuring TiDB Cluster](configure-a-tidb-cluster.md).
+See [TiDB Operator API Documentation](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md) and [Configuring TiDB Cluster](configure-a-tidb-cluster.md).
 
 ## Manage multiple TiDB clusters
 

diff --git a/en/deploy-on-aws-eks.md b/en/deploy-on-aws-eks.md
@@ -164,7 +164,7 @@ You can use the `terraform output` command to get the output again.
     cp manifests/db.yaml.example db.yaml && cp manifests/db-monitor.yaml.example db-monitor.yaml
     ```
 
-    To complete the CR file configuration, refer to [API documentation](api-references.md) and [Configure a TiDB Cluster Using TidbCluster](configure-a-tidb-cluster.md).
+    To complete the CR file configuration, refer to [API documentation](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md) and [Configure a TiDB Cluster Using TidbCluster](configure-a-tidb-cluster.md).
 
     * To deploy TiFlash, configure `spec.tiflash` in `db.yaml` as follows:
 

diff --git a/en/deploy-on-gcp-gke.md b/en/deploy-on-gcp-gke.md
@@ -179,7 +179,7 @@ This section describes how to deploy a TiDB cluster.
     sed 's/CLUSTER_NAME/${cluster_name}/g' db-monitor.yaml.example > db-monitor.yaml
     ```
 
-    To complete the CR file configuration, refer to [TiDB Operator API documentation](api-references.md) and [Configure Cluster using TidbCluster](configure-a-tidb-cluster.md).
+    To complete the CR file configuration, refer to [TiDB Operator API documentation](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md) and [Configure Cluster using TidbCluster](configure-a-tidb-cluster.md).
 
     > **Note:**
     >

diff --git a/en/initialize-a-cluster.md b/en/initialize-a-cluster.md
@@ -16,7 +16,7 @@ This document describes how to initialize a TiDB cluster in Kubernetes (K8s), sp
 
 ## Configure TidbInitializer
 
-Refer to [TidbInitializer example](https://github.com/pingcap/tidb-operator/blob/master/manifests/initializer/tidb-initializer.yaml), [API documentation](api-references.md), and the following steps to complete TidbInitializer Custom Resource (CR), and save it to the `${cluster_name}/tidb-initializer.yaml` file. Please switch the TidbInitializer example and API documentation to the currently used version of TiDB Operator.
+Refer to [TidbInitializer example](https://github.com/pingcap/tidb-operator/blob/master/manifests/initializer/tidb-initializer.yaml), [API documentation](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md), and the following steps to complete TidbInitializer Custom Resource (CR), and save it to the `${cluster_name}/tidb-initializer.yaml` file. Please switch the TidbInitializer example and API documentation to the currently used version of TiDB Operator.
 
 ### Set initial account and password
 

diff --git a/en/monitor-using-tidbmonitor.md b/en/monitor-using-tidbmonitor.md
@@ -294,4 +294,4 @@ type: kubernetes.io/tls
 
 ## References
 
-For more detailed API information of TidbMonitor, see [TiDB Operator API documentation](api-references.md).
+For more detailed API information of TidbMonitor, see [TiDB Operator API documentation](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md).
diff --git a/en/notes-tidb-operator-v1.1.md b/en/notes-tidb-operator-v1.1.md
@@ -15,11 +15,11 @@ Since TiDB Operator v1.1.0, PingCAP no longer updates or maintains the tidb-clus
 
 | Components/Features | Managements in TiDB Operator v1.1 |
 | :--- | :--- |
-| TiDB Cluster (PD, TiDB, TiKV) | [TidbCluster CR](api-references.md) |
+| TiDB Cluster (PD, TiDB, TiKV) | [TidbCluster CR](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md) |
 | TiDB Monitor | [TidbMonitor CR](https://github.com/pingcap/tidb-operator/blob/master/manifests/monitor/tidb-monitor.yaml) |
 | TiDB Initializer | [TidbInitializer CR](https://github.com/pingcap/tidb-operator/blob/master/manifests/initializer/tidb-initializer.yaml) |
 | Scheduled Backup | [BackupSchedule CR](https://github.com/pingcap/tidb-operator/blob/master/manifests/backup/backup-schedule-aws-s3-br.yaml) |
-| Pump | [TidbCluster CR](api-references.md) |
+| Pump | [TidbCluster CR](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md) |
 | Drainer | [tidb-drainer chart](https://github.com/pingcap/tidb-operator/tree/master/charts/tidb-drainer) |
 | Importer | [tikv-importer chart](https://github.com/pingcap/tidb-operator/tree/master/charts/tikv-importer) |
 

diff --git a/zh/whats-new-in-v1.1.md b/zh/whats-new-in-v1.1.md
@@ -33,4 +33,4 @@ TiDB Operator v1.1 在 v1.0 基础上新增 TiDB 4.0 功能特性支持，TiKV
 - 新增可选的[增强型 StatefulSet 控制器](advanced-statefulset.md)，提供对指定 Pod 进行删除的功能（开启 `AdvancedStatefulSet` 特性开关后使用）
 
 完整发布日志参见 [1.1 CHANGE LOG](https://github.com/pingcap/tidb-operator/blob/master/CHANGELOG-1.1.md) 。
-TiDB Operator 在 Kubernetes 上部署参见[安装文档](deploy-tidb-operator.md)，CRD 文档参见 [API References](https://github.com/pingcap/docs-tidb-operator/blob/master/zh/api-references.md) 。
+TiDB Operator 在 Kubernetes 上部署参见[安装文档](deploy-tidb-operator.md)，CRD 文档参见 [API References](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md)。