v2 docs cleanup

Signed-off-by: lucperkins <[email protected]>
serathius · Jan 9, 2020 · 8662174 · 8662174
1 parent 28ba8f6
commit 8662174
Show file tree

Hide file tree

Showing 44 changed files with 134 additions and 389 deletions.
diff --git a/content/docs/v2/04_to_2_snapshot_migration.md b/content/docs/v2/04_to_2_snapshot_migration.md
@@ -2,21 +2,17 @@
 title: Snapshot Migration
 ---
 
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../docs.md#documentation
-
 You can migrate a snapshot of your data from a v0.4.9+ cluster into a new etcd 2.2 cluster using a snapshot migration. After snapshot migration, the etcd indexes of your data will change. Many etcd applications rely on these indexes to behave correctly. This operation should only be done while all etcd applications are stopped.
 
 To get started get the newest data snapshot from the 0.4.9+ cluster:
 
-```
+```shell
 curl http://cluster.example.com:4001/v2/migration/snapshot > backup.snap
 ```
 
 Now, import the snapshot into your new cluster:
 
-```
+```shell
 etcdctl --endpoint new_cluster.example.com import --snap backup.snap
 ```
 

diff --git a/content/docs/v2/admin_guide.md b/content/docs/v2/admin_guide.md
@@ -2,8 +2,6 @@
 title: Administration
 ---
 
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
 ## Data Directory
 
 ### Lifecycle
@@ -305,15 +303,15 @@ By default, etcd uses the default configuration of the Go 1.4 runtime, which mea
 
 When using etcd in heavy-load scenarios on machines with multiple cores it will usually be desirable to increase the number of threads that etcd can utilize. To do this, simply set the environment variable GOMAXPROCS to the desired number when starting etcd. For more information on this variable, see the [Go runtime documentation][golang-runtime].
 
-[add-a-member]: runtime-configuration.md#add-a-new-member
+[add-a-member]: ../runtime-configuration#add-a-new-member
 [golang1.5-runtime]: https://golang.org/doc/go1.5#runtime
 [golang-memstats]: https://golang.org/pkg/runtime/#MemStats
 [golang-runtime]: https://golang.org/pkg/runtime
-[metrics]: metrics.md
+[metrics]: ../metrics
 [prometheus]: http://prometheus.io/
-[remove-a-member]: runtime-configuration.md#remove-a-member
-[runtime-reconfig]: runtime-configuration.md#cluster-reconfiguration-operations
+[remove-a-member]: ../runtime-configuration#remove-a-member
+[runtime-reconfig]: ../runtime-configuration#cluster-reconfiguration-operations
 [snap-pkg]: http://godoc.org/github.com/coreos/etcd/snap
-[update-a-member]: runtime-configuration.md#update-a-member
+[update-a-member]: ../runtime-configuration#update-a-member
 [v3-docs]: /docs/latest
 [wal-pkg]: http://godoc.org/github.com/coreos/etcd/wal
diff --git a/content/docs/v2/api.md b/content/docs/v2/api.md
@@ -2,10 +2,6 @@
 title: etcd API
 ---
 
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../docs.md#documentation
-
 ## Running a Single Machine Cluster
 
 These examples will use a single member cluster to show you the basics of the etcd REST API.

diff --git a/content/docs/v2/api_v3.md b/content/docs/v2/api_v3.md
diff --git a/content/docs/v2/auth_api.md b/content/docs/v2/auth_api.md
@@ -2,11 +2,8 @@
 title: v2 Auth and Security
 ---
 
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../docs.md#documentation
-
 ## etcd Resources
+
 There are three types of resources in etcd
 
 1. permission resources: users and roles in the user store

diff --git a/content/docs/v2/authentication.md b/content/docs/v2/authentication.md
@@ -2,10 +2,6 @@
 title: Authentication Guide
 ---
 
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../docs.md#documentation
-
 ## Overview
 
 Authentication -- having users and roles in etcd -- was added in etcd 2.1. This guide will help you set up basic authentication in etcd.
@@ -183,4 +179,4 @@ $ etcdctl -u user get foo
 
 Otherwise, all `etcdctl` commands remain the same. Users and roles can still be created and modified, but require authentication by a user with the root role.
 
-[auth-api]: auth_api.md
+[auth-api]: ../auth_api
diff --git a/content/docs/v2/backward_compatibility.md b/content/docs/v2/backward_compatibility.md
@@ -2,10 +2,6 @@
 title: Backward Compatibility
 ---
 
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../docs.md#documentation
-
 The main goal of etcd 2.0 release is to improve cluster safety around bootstrapping and dynamic reconfiguration. To do this, we deprecated the old error-prone APIs and provide a new set of APIs.
 
 The other main focus of this release was a more reliable Raft implementation, but as this change is internal it should not have any notable effects to users.
@@ -51,27 +47,22 @@ We added an option for a consistent read in the old version of etcd since etcd 0
 
 ## Standby
 
-etcd 0.4’s standby mode has been deprecated. [Proxy mode][proxymode] is introduced to solve a subset of problems standby was solving.
+etcd 0.4’s standby mode has been deprecated. [Proxy mode](../proxy) is introduced to solve a subset of problems standby was solving.
 
 Standby mode was intended for large clusters that had a subset of the members acting in the consensus process. Overall this process was too magical and allowed for operators to back themselves into a corner.
 
 Proxy mode in 2.0 will provide similar functionality, and with improved control over which machines act as proxies due to the operator specifically configuring them. Proxies also support read only or read/write modes for increased security and durability.
 
-[proxymode]: proxy.md
-
 ## Discovery Service
 
-A size key needs to be provided inside a [discovery token][discoverytoken].
-
-[discoverytoken]: clustering.md#custom-etcd-discovery-service
+A size key needs to be provided inside a [discovery token](../clustering#custom-etcd-discovery-service).
 
 ## HTTP Admin API
 
-`v2/admin` on peer url and `v2/keys/_etcd` are unified under the new [v2/members API][members-api] to better explain which machines are part of an etcd cluster, and to simplify the keyspace for all your use cases.
-
-[members-api]: members_api.md
+`v2/admin` on peer url and `v2/keys/_etcd` are unified under the new [v2/members API](../members-api) to better explain which machines are part of an etcd cluster, and to simplify the keyspace for all your use cases.
 
 ## HTTP Key Value API
+
 - The follower can now transparently proxy write requests to the leader. Clients will no longer see 307 redirections to the leader from etcd.
 
 - Expiration time is in UTC instead of local time.

diff --git a/content/docs/v2/benchmarks/README.md b/content/docs/v2/benchmarks/README.md
diff --git a/content/docs/v2/benchmarks/_index.md b/content/docs/v2/benchmarks/_index.md
@@ -0,0 +1,3 @@
+---
+title: Benchmarks
+---
diff --git a/content/docs/v2/benchmarks/etcd-2-1-0-alpha-benchmarks.md b/content/docs/v2/benchmarks/etcd-2-1-0-alpha-benchmarks.md
@@ -1,7 +1,6 @@
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../../docs.md#documentation
-
+---
+title: etcd 2.1.0-alpha benchmarks
+---
 
 ## Physical machines
 

diff --git a/content/docs/v2/benchmarks/etcd-2-2-0-benchmarks.md b/content/docs/v2/benchmarks/etcd-2-2-0-benchmarks.md
@@ -1,9 +1,6 @@
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../../docs.md#documentation
-
-
-# Benchmarking etcd v2.2.0
+---
+title: Benchmarking etcd v2.2.0
+---
 
 ## Physical Machines
 

diff --git a/content/docs/v2/benchmarks/etcd-2-2-0-rc-benchmarks.md b/content/docs/v2/benchmarks/etcd-2-2-0-rc-benchmarks.md
@@ -1,7 +1,6 @@
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../../docs.md#documentation
-
+---
+title: etcd 2.2.0-rc benchmarks
+---
 
 ## Physical machines
 

diff --git a/content/docs/v2/benchmarks/etcd-2-2-0-rc-memory-benchmarks.md b/content/docs/v2/benchmarks/etcd-2-2-0-rc-memory-benchmarks.md
@@ -1,7 +1,6 @@
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../../docs.md#documentation
-
+---
+title: etcd 2.2.0-rc memory benchmarks
+---
 
 ## Physical machine
 

diff --git a/content/docs/v2/benchmarks/etcd-3-demo-benchmarks.md b/content/docs/v2/benchmarks/etcd-3-demo-benchmarks.md
@@ -1,7 +1,6 @@
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../../docs.md#documentation
-
+---
+title: etcd 3 demo benchmarks
+---
 
 ## Physical machines
 

diff --git a/content/docs/v2/benchmarks/etcd-3-watch-memory-benchmark.md b/content/docs/v2/benchmarks/etcd-3-watch-memory-benchmark.md
@@ -1,9 +1,6 @@
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../../docs.md#documentation
-
-
-# Watch Memory Usage Benchmark
+---
+title: Watch Memory Usage Benchmark
+---
 
 *NOTE*: The watch features are under active development, and their memory usage may change as that development progresses. We do not expect it to significantly increase beyond the figures stated below.
 

diff --git a/content/docs/v2/benchmarks/etcd-storage-memory-benchmark.md b/content/docs/v2/benchmarks/etcd-storage-memory-benchmark.md
@@ -1,9 +1,6 @@
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../../docs.md#documentation
-
-
-# Storage Memory Usage Benchmark
+---
+title: Storage Memory Usage Benchmark
+---
 
 <!---todo: link storage to storage design doc-->
 Two components of etcd storage consume physical memory. The etcd process allocates an *in-memory index* to speed key lookup. The process's *page cache*, managed by the operating system, stores recently-accessed data from disk for quick re-use.

diff --git a/content/docs/v2/branch_management.md b/content/docs/v2/branch_management.md
@@ -2,10 +2,6 @@
 title: Branch Management
 ---
 
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../docs.md#documentation
-
 ## Guide
 
 * New development occurs on the [master branch][master].
@@ -27,6 +23,6 @@ Before the release of the next stable version, feature PRs will be frozen. We wi
 
 All branches with prefix `release-` are considered _stable_ branches.
 
-After every minor release (http://semver.org/), we will have a new stable branch for that release. We will keep fixing the backwards-compatible bugs for the latest stable release, but not previous releases. The _patch_ release, incorporating any bug fixes, will be once every two weeks, given any patches.
+After every minor release (https://semver.org/), we will have a new stable branch for that release. We will keep fixing the backwards-compatible bugs for the latest stable release, but not previous releases. The _patch_ release, incorporating any bug fixes, will be once every two weeks, given any patches.
 
 [master]: https://github.com/coreos/etcd/tree/master
diff --git a/content/docs/v2/clustering.md b/content/docs/v2/clustering.md
@@ -2,10 +2,6 @@
 title: Clustering Guide
 ---
 
-**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.**
-
-[v3-docs]: ../docs.md#documentation
-
 ## Overview
 
 Starting an etcd cluster statically requires that each member knows another in the cluster. In a number of cases, you might not know the IPs of your cluster members ahead of time. In these cases, you can bootstrap an etcd cluster with the help of a discovery service.