From 862b3fe2be99b912d184fadc3dec43d1ea76238a Mon Sep 17 00:00:00 2001 From: Gyu-Ho Lee Date: Fri, 24 Jun 2016 10:40:55 -0700 Subject: [PATCH] *: move 'Project detail' to op-guide --- Documentation/docs.md | 5 +++ Documentation/op-guide/supported-platform.md | 14 +++++++++ Documentation/op-guide/versioning.md | 17 +++++++++++ README.md | 32 +------------------- 4 files changed, 37 insertions(+), 31 deletions(-) create mode 100644 Documentation/op-guide/supported-platform.md create mode 100644 Documentation/op-guide/versioning.md diff --git a/Documentation/docs.md b/Documentation/docs.md index 7f6d39f70..55d2733f9 100644 --- a/Documentation/docs.md +++ b/Documentation/docs.md @@ -28,6 +28,8 @@ Administrators who need to create reliable and scalable key-value stores for the - [Understand failures][failures] - [Disaster recovery][recovery] - [Performance][performance] + - [Versioning][versioning] + - [Supported platform][supported_platform] ## Learning @@ -63,3 +65,6 @@ To learn more about the concepts and internals behind etcd, read the following p [v2_migration]: op-guide/v2-migration.md [container]: op-guide/container.md [understand_apis]: learning/api.md +[versioning]: op-guide/versioning.md +[supported_platform]: op-guide/supported-platform.md + diff --git a/Documentation/op-guide/supported-platform.md b/Documentation/op-guide/supported-platform.md new file mode 100644 index 000000000..e65a3e549 --- /dev/null +++ b/Documentation/op-guide/supported-platform.md @@ -0,0 +1,14 @@ +## Supported platform + +### 32-bit and other unsupported systems + +etcd has known issues on 32-bit systems due to a bug in the Go runtime. See #[358][358] for more information. + +To avoid inadvertently running a possibly unstable etcd server, `etcd` on unsupported architectures will print +a warning message and immediately exit if the environment variable `ETCD_UNSUPPORTED_ARCH` is not set to +the target architecture. + +Currently only the amd64 architecture is officially supported by `etcd`. + +[358]: https://github.com/coreos/etcd/issues/358 + diff --git a/Documentation/op-guide/versioning.md b/Documentation/op-guide/versioning.md new file mode 100644 index 000000000..90c95a0ee --- /dev/null +++ b/Documentation/op-guide/versioning.md @@ -0,0 +1,17 @@ +## Versioning + +### Service versioning + +etcd uses [semantic versioning](http://semver.org) +New minor versions may add additional features to the API. + +Get the running etcd cluster version with `etcdctl`: + +```sh +ETCDCTL_API=3 etcdctl --endpoints=127.0.0.1:2379 endpoint status +``` + +### API versioning + +The `v3` API responses should not change after the 3.0.0 release but new features will be added over time. + diff --git a/README.md b/README.md index 5d5624556..1f59c4645 100644 --- a/README.md +++ b/README.md @@ -127,37 +127,7 @@ See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the co See [reporting bugs](Documentation/reporting_bugs.md) for details about reporting any issue you may encounter. -## Project details - -### Versioning - -#### Service versioning - -etcd uses [semantic versioning](http://semver.org) -New minor versions may add additional features to the API. - -Get the running etcd cluster version with `etcdctl`: - -```sh -ETCDCTL_API=3 etcdctl --endpoints=127.0.0.1:2379 endpoint status -``` - -#### API versioning - -The `v3` API responses should not change after the 3.0.0 release but new features will be added over time. - -#### 32-bit and other unsupported systems - -etcd has known issues on 32-bit systems due to a bug in the Go runtime. See #[358][358] for more information. - -To avoid inadvertently running a possibly unstable etcd server, `etcd` on unsupported architectures will print -a warning message and immediately exit if the environment variable `ETCD_UNSUPPORTED_ARCH` is not set to -the target architecture. - -Currently only the amd64 architecture is officially supported by `etcd`. - -[358]: https://github.com/coreos/etcd/issues/358 - ### License etcd is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details. +