From 9585daf0a98b96cbcf86c210d3b934816d38971c Mon Sep 17 00:00:00 2001 From: Katsuyuki Tateishi Date: Fri, 3 Jun 2016 21:43:17 +0900 Subject: [PATCH 1/2] Doc: fix wrong links and remove unused or duplicate ones --- Documentation/dev-guide/local_cluster.md | 2 +- Documentation/op-guide/clustering.md | 6 +++--- Documentation/op-guide/configuration.md | 8 ++------ 3 files changed, 6 insertions(+), 10 deletions(-) diff --git a/Documentation/dev-guide/local_cluster.md b/Documentation/dev-guide/local_cluster.md index 6d1b7610a..5dfcbc1b8 100644 --- a/Documentation/dev-guide/local_cluster.md +++ b/Documentation/dev-guide/local_cluster.md @@ -86,5 +86,5 @@ hello To learn more about interacting with etcd, read [interacting with etcd section][interacting]. [interacting]: ./interacting_v3.md -[clustering]: ./clustering.md +[clustering]: ../op-guide/clustering.md diff --git a/Documentation/op-guide/clustering.md b/Documentation/op-guide/clustering.md index f3a1f636a..385832b13 100644 --- a/Documentation/op-guide/clustering.md +++ b/Documentation/op-guide/clustering.md @@ -461,9 +461,9 @@ When the `--proxy` flag is set, etcd runs in [proxy mode][proxy]. This proxy mod To setup an etcd cluster with proxies of v2 API, please read the the [clustering doc in etcd 2.3 release][clustering_etcd2]. -[conf-adv-client]: configuration.md#-advertise-client-urls -[conf-listen-client]: configuration.md#-listen-client-urls -[discovery-proto]: dev-internal/discovery_protocol.md +[conf-adv-client]: configuration.md#--advertise-client-urls +[conf-listen-client]: configuration.md#--listen-client-urls +[discovery-proto]: ../dev-internal/discovery_protocol.md [rfc-srv]: http://www.ietf.org/rfc/rfc2052.txt [runtime-conf]: runtime-configuration.md [runtime-reconf-design]: runtime-reconf-design.md diff --git a/Documentation/op-guide/configuration.md b/Documentation/op-guide/configuration.md index ec9aae976..0934b4bb6 100644 --- a/Documentation/op-guide/configuration.md +++ b/Documentation/op-guide/configuration.md @@ -8,8 +8,6 @@ The [official etcd ports][iana-ports] are 2379 for client requests and 2380 for To start etcd automatically using custom settings at startup in Linux, using a [systemd][systemd-intro] unit is highly recommended. -[systemd-intro]: http://freedesktop.org/wiki/Software/systemd/ - ## Member Flags ### --name @@ -39,7 +37,7 @@ To start etcd automatically using custom settings at startup in Linux, using a [ + env variable: ETCD_HEARTBEAT_INTERVAL ### --election-timeout -+ Time (in milliseconds) for an election to timeout. See [Documentation/tuning.md](tuning.md#time-parameters) for details. ++ Time (in milliseconds) for an election to timeout. See [Documentation/tuning.md][tuning] for details. + default: "1000" + env variable: ETCD_ELECTION_TIMEOUT @@ -281,9 +279,7 @@ Follow the instructions when using these flags. [discovery]: clustering.md#discovery [iana-ports]: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=etcd [proxy]: ../v2/proxy.md -[reconfig]: runtime-configuration.md [restore]: ../v2/admin_guide.md#restoring-a-backup -[rfc-v3]: rfc/v3api.md [security]: security.md [systemd-intro]: http://freedesktop.org/wiki/Software/systemd/ -[tuning]: tuning.md#time-parameters +[tuning]: ../tuning.md#time-parameters From 5bff4d85d6e7f5cc936ed6c1dc6dddba4797f285 Mon Sep 17 00:00:00 2001 From: Katsuyuki Tateishi Date: Fri, 3 Jun 2016 21:43:42 +0900 Subject: [PATCH 2/2] Doc: fix links using url for internal doc --- Documentation/op-guide/failures.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/op-guide/failures.md b/Documentation/op-guide/failures.md index aacfd8250..ce2bd6ca6 100644 --- a/Documentation/op-guide/failures.md +++ b/Documentation/op-guide/failures.md @@ -40,5 +40,5 @@ A cluster bootstrap is only successful if all required members successfully star Of course, it is possible to recover a failed bootstrapped cluster like recovering a running cluster. However, it almost always takes more time and resources to recover that cluster than bootstrapping a new one, since there is no data to recover. -[backup]: https://github.com/coreos/etcd/blob/master/Documentation/op-guide/maintenance.md#snapshot-backup -[unrecoverable]: https://github.com/coreos/etcd/blob/master/Documentation/op-guide/recovery.md#disaster-recovery +[backup]: maintenance.md#snapshot-backup +[unrecoverable]: recovery.md#disaster-recovery