From a2749bad53fc3b8f0cfd0f833cefa85670c35d3a Mon Sep 17 00:00:00 2001 From: Yicheng Qin Date: Fri, 18 Apr 2014 10:36:59 -0700 Subject: [PATCH] docs(modules): make reasons for deprecation much more clear --- Documentation/api.md | 4 ++-- Documentation/modules.md | 7 +++++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/Documentation/api.md b/Documentation/api.md index 4bb8fff46..ed25b74fb 100644 --- a/Documentation/api.md +++ b/Documentation/api.md @@ -849,7 +849,7 @@ The lock module is used to serialize access to resources used by clients. Multiple clients can attempt to acquire a lock but only one can have it at a time. Once the lock is released, the next client waiting for the lock will receive it. -**Warning:** This module is deprecated at v0.4, and will be back later. See [Modules][modules] for more details. +**Warning:** This module is deprecated at v0.4. See [Modules][modules] for more details. ### Acquiring a Lock @@ -996,7 +996,7 @@ If you specify a field other than `index` or `value` then you'll receive the fol The leader module wraps the lock module to provide a simple interface for electing a single leader in a cluster. -**Warning:** This module is deprecated at v0.4, and will be back later. See [Modules][modules] for more details. +**Warning:** This module is deprecated at v0.4. See [Modules][modules] for more details. [modules]: https://github.com/coreos/etcd/blob/master/Documentation/modules.md diff --git a/Documentation/modules.md b/Documentation/modules.md index d8e0cc69e..757c729dd 100644 --- a/Documentation/modules.md +++ b/Documentation/modules.md @@ -3,8 +3,11 @@ etcd has a number of modules that are built on top of the core etcd API. These modules provide things like dashboards, locks and leader election. -**Warning**: Modules is deprecated from v0.4, and is expected to be added back in the near future. -For now, we are choosing to focus on raft algorithm and etcd core to make sure that it works correctly and fast. And it is time consuming to maintain these modules in this period, given that etcd's API changes from time to time. Moreover, the lock module has some unfixed bugs, which may mislead users. But we also notice that these modules are popular and useful, and plan to add them back with full functionality as soon as possible. +**Warning**: Modules are deprecated from v0.4 until we have a solid base we can apply them back onto. +For now, we are choosing to focus on raft algorithm and core etcd to make sure that it works correctly and fast. +And it is time consuming to maintain these modules in this period, given that etcd's API changes from time to time. +Moreover, the lock module has some unfixed bugs, which may mislead users. +But we also notice that these modules are popular and useful, and plan to add them back with full functionality as soon as possible. ### Dashboard