vitalif
/
etcd
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation/v2: fix broken links 

Signed-off-by: Gyu-Ho Lee <gyuhox@gmail.com>
release-3.2
Gyu-Ho Lee 2017-05-03 09:40:40 -07:00
parent 9fee35b02d
commit e4e057f8f7
8 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/v2/README.md
View File

@ -67,13 +67,13 @@ You have successfully started an etcd and written a key to the store.
The [official etcd ports][iana-ports] are 2379 for client requests, and 2380 for peer communication. To maintain compatibility, some etcd configuration and documentation continues to refer to the legacy ports 4001 and 7001, but all new etcd use and discussion should adopt the IANA-assigned ports. The legacy ports 4001 and 7001 will be fully deprecated, and support for their use removed, in future etcd releases. The [official etcd ports][iana-ports] are 2379 for client requests, and 2380 for peer communication. To maintain compatibility, some etcd configuration and documentation continues to refer to the legacy ports 4001 and 7001, but all new etcd use and discussion should adopt the IANA-assigned ports. The legacy ports 4001 and 7001 will be fully deprecated, and support for their use removed, in future etcd releases.
[iana-ports]: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=etcd [iana-ports]: http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt
### Running local etcd cluster ### Running local etcd cluster
First install [goreman](https://github.com/mattn/goreman), which manages Procfile-based applications. First install [goreman](https://github.com/mattn/goreman), which manages Procfile-based applications.
Our [Procfile script](./Procfile) will set up a local example cluster. You can start it with: Our [Procfile script](../../V2Procfile) will set up a local example cluster. You can start it with:
```sh ```sh
goreman start goreman start
@ -162,4 +162,4 @@ Currently only the amd64 architecture is officially supported by `etcd`.
### License ### License
etcd is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details. etcd is under the Apache 2.0 license. See the [LICENSE](../../LICENSE) file for details.

14
Documentation/v2/api_v3.md
View File

@ -83,10 +83,10 @@ etcd does not ensure linearizability for watch operations. Users are expected to
etcd ensures linearizability for all other operations by default. Linearizability comes with a cost, however, because linearized requests must go through the Raft consensus process. To obtain lower latencies and higher throughput for read requests, clients can configure a request’s consistency mode to `serializable`, which may access stale data with respect to quorum, but removes the performance penalty of linearized accesses' reliance on live consensus. etcd ensures linearizability for all other operations by default. Linearizability comes with a cost, however, because linearized requests must go through the Raft consensus process. To obtain lower latencies and higher throughput for read requests, clients can configure a request’s consistency mode to `serializable`, which may access stale data with respect to quorum, but removes the performance penalty of linearized accesses' reliance on live consensus.
[persistent-ds]: [https://en.wikipedia.org/wiki/Persistent_data_structure] [persistent-ds]: https://en.wikipedia.org/wiki/Persistent_data_structure
[btree]: [https://en.wikipedia.org/wiki/B-tree] [btree]: https://en.wikipedia.org/wiki/B-tree
[b+tree]: [https://en.wikipedia.org/wiki/B%2B_tree] [b+tree]: https://en.wikipedia.org/wiki/B%2B_tree
[seq_consistency]: [https://en.wikipedia.org/wiki/Consistency_model#Sequential_consistency] [seq_consistency]: https://en.wikipedia.org/wiki/Consistency_model#Sequential_consistency
[strict_consistency]: [https://en.wikipedia.org/wiki/Consistency_model#Strict_consistency] [strict_consistency]: https://en.wikipedia.org/wiki/Consistency_model#Strict_consistency
[serializable_isolation]: [https://en.wikipedia.org/wiki/Isolation_(database_systems)#Serializable] [serializable_isolation]: https://en.wikipedia.org/wiki/Isolation_(database_systems)#Serializable
[Linearizability]: [#Linearizability] [Linearizability]: #linearizability

1
Documentation/v2/backward_compatibility.md
View File

@ -56,6 +56,7 @@ Proxy mode in 2.0 will provide similar functionality, and with improved control
## Discovery Service ## Discovery Service
A size key needs to be provided inside a [discovery token][discoverytoken]. A size key needs to be provided inside a [discovery token][discoverytoken].
[discoverytoken]: clustering.md#custom-etcd-discovery-service [discoverytoken]: clustering.md#custom-etcd-discovery-service
## HTTP Admin API ## HTTP Admin API

2
Documentation/v2/configuration.md
View File

@ -272,7 +272,7 @@ Follow the instructions when using these flags.
[build-cluster]: clustering.md#static [build-cluster]: clustering.md#static
[reconfig]: runtime-configuration.md [reconfig]: runtime-configuration.md
[discovery]: clustering.md#discovery [discovery]: clustering.md#discovery
[iana-ports]: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=etcd [iana-ports]: http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt
[proxy]: proxy.md [proxy]: proxy.md
[reconfig]: runtime-configuration.md [reconfig]: runtime-configuration.md
[restore]: admin_guide.md#restoring-a-backup [restore]: admin_guide.md#restoring-a-backup

1
Documentation/v2/libraries-and-tools.md
View File

@ -115,7 +115,6 @@
- [mattn/etcdenv](https://github.com/mattn/etcdenv) - "env" shebang with etcd integration - [mattn/etcdenv](https://github.com/mattn/etcdenv) - "env" shebang with etcd integration
- [kelseyhightower/confd](https://github.com/kelseyhightower/confd) - Manage local app config files using templates and data from etcd - [kelseyhightower/confd](https://github.com/kelseyhightower/confd) - Manage local app config files using templates and data from etcd
- [configdb](https://git.autistici.org/ai/configdb/tree/master) - A REST relational abstraction on top of arbitrary database backends, aimed at storing configs and inventories. - [configdb](https://git.autistici.org/ai/configdb/tree/master) - A REST relational abstraction on top of arbitrary database backends, aimed at storing configs and inventories.
- [scrz](https://github.com/scrz/scrz) - Container manager, stores configuration in etcd.
- [fleet](https://github.com/coreos/fleet) - Distributed init system - [fleet](https://github.com/coreos/fleet) - Distributed init system
- [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) - Container cluster manager introduced by Google. - [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) - Container cluster manager introduced by Google.
- [mailgun/vulcand](https://github.com/mailgun/vulcand) - HTTP proxy that uses etcd as a configuration backend. - [mailgun/vulcand](https://github.com/mailgun/vulcand) - HTTP proxy that uses etcd as a configuration backend.

2
Documentation/v2/reporting_bugs.md
View File

@ -1,6 +1,6 @@
# Reporting Bugs # Reporting Bugs
If you find bugs or documentation mistakes in the etcd project, please let us know by [opening an issue][issue]. We treat bugs and mistakes very seriously and believe no issue is too small. Before creating a bug report, please check that an issue reporting the same problem does not already exist. If you find bugs or documentation mistakes in the etcd project, please let us know by [opening an issue][etcd-issue]. We treat bugs and mistakes very seriously and believe no issue is too small. Before creating a bug report, please check that an issue reporting the same problem does not already exist.
To make your bug report accurate and easy to understand, please try to create bug reports that are: To make your bug report accurate and easy to understand, please try to create bug reports that are:

4
Documentation/v2/rfc/v3api.md
View File

@ -207,5 +207,5 @@ WatchResponse {
``` ```
[api-protobuf]: https://github.com/coreos/etcd/blob/master/etcdserver/etcdserverpb/rpc.proto [api-protobuf]: https://github.com/coreos/etcd/blob/release-2.3/etcdserver/etcdserverpb/rpc.proto
[kv-protobuf]: https://github.com/coreos/etcd/blob/master/storage/storagepb/kv.proto [kv-protobuf]: https://github.com/coreos/etcd/blob/release-2.3/storage/storagepb/kv.proto

2
etcdctl/READMEv2.md
View File

@ -331,6 +331,6 @@ etcdctl is under the Apache 2.0 license. See the [LICENSE][license] file for det
[authentication]: ../Documentation/v2/authentication.md [authentication]: ../Documentation/v2/authentication.md
[etcd]: https://github.com/coreos/etcd [etcd]: https://github.com/coreos/etcd
[github-release]: https://github.com/coreos/etcd/releases/ [github-release]: https://github.com/coreos/etcd/releases/
[license]: https://github.com/coreos/etcdctl/blob/master/LICENSE [license]: ../LICENSE
[semver]: http://semver.org/ [semver]: http://semver.org/
[username-flag]: #--username--u [username-flag]: #--username--u