Hector created ZOOKEEPER-2090:
---------------------------------
Summary: Fix Zookeeper docs "To be done" notices
Key: ZOOKEEPER-2090
URL: https://issues.apache.org/jira/browse/ZOOKEEPER-2090
Project: ZooKeeper
Issue Type: Bug
Components: documentation
Environment: Official website
Reporter: Hector
Priority: Trivial
The docs on the website are full of TBDs since a long time ago. While there is
not a full lack of docs, and you can get going with what there is, the main
general-purpose entry points are not too polished and they give the impression
ZK is not very well maintained to newcomers and anyone who just wants to see
how ZK is progressing and refresh concepts.
The ZK overview doc (http://zookeeper.apache.org/doc/trunk/zookeeperOver.html)
is supposed to be a first entry point for new Zookeeper users and it is full of
_\[tbd\]s_:
{quote}
When the session ends the znode is deleted. Ephemeral nodes are useful when you
want to implement \[tbd\].
{quote}
{quote}
And if the connection between the client and one of the Zoo Keeper servers is
broken, the client will receive a local notification. These can be used to
\[tbd\].
{quote}
{quote}
Timeliness - The clients view of the system is guaranteed to be up-to-date
within a certain time bound.
For more information on these, and how they can be used, see \[tbd\]
{quote}
{quote}
For a more in-depth discussion on these, and how they can be used to implement
higher level operations, please refer to \[tbd\]
{quote}
{quote}
Some distributed applications have used it to: \[tbd: add uses from white paper
and video presentation.\] For more information, see \[tbd\]
{quote}
{quote}
These znodes exists as long as the session that created the znode is active.
When the session ends the znode is deleted. Ephemeral nodes are useful when you
want to implement \[tbd\].
{quote}
The second entry point, "Getting Started"
(http://zookeeper.apache.org/doc/trunk/zookeeperStarted.html)
{quote}
\[tbd: what is the other config param?\]
{quote}
Programmers guide
(http://zookeeper.apache.org/doc/trunk/zookeeperProgrammers.html)
{quote}
"If the version it supplies doesn't match the actual version of the data, the
update will fail. (This behavior can be overridden. For more information see...
)\[tbd...\]"
{quote}
{quote}
Connecting to ZooKeeper
Read Operations
Write Operations
Handling Watches
Miscelleaneous ZooKeeper Operations
Program Structure, with Simple Example
\[tbd\]
{quote}
{quote}
ZooKeeper Whitepaper \[tbd: find url\]
The definitive discussion of ZooKeeper design and performance, by Yahoo!
Research
API Reference \[tbd: find url\]
The complete reference to the ZooKeeper API
{quote}
Administration guide (http://zookeeper.apache.org/doc/trunk/zookeeperAdmin.html)
{quote}
Provisioning
Things to Consider: ZooKeeper Strengths and Limitations
Administering
{quote}
{quote}
TBD - tuning options for netty - currently there are none that are netty
specific but we should add some. Esp around max bound on the number of reader
worker threads netty creates.
TBD - how to manage encryption
TBD - how to manage certificates
{quote}
Since it is not a big deal to fix these, I think it is worth it to spend some
hours doing it.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
