Browse Source

ZOOKEEPER-3355: Remove 'tbd' From Docs

Author: Beluga Behr <dam6923@gmail.com>

Reviewers: Enrico Olivelli <eolivelli@apache.org>, Norbert Kalmar <nkalmar@apache.org>

Closes #902 from BELUGABEHR/ZOOKEEPER-3355
Beluga Behr 6 years ago
parent
commit
fdd6d9b910

+ 0 - 2
zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md

@@ -1451,8 +1451,6 @@ to **org.apache.zookeeper.server.NettyServerCnxnFactory**;
 for the client, set **zookeeper.clientCnxnSocket**
 for the client, set **zookeeper.clientCnxnSocket**
 to **org.apache.zookeeper.ClientCnxnSocketNetty**.
 to **org.apache.zookeeper.ClientCnxnSocketNetty**.
 
 
-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.
-
 <a name="Quorum+TLS"></a>
 <a name="Quorum+TLS"></a>
 
 
 #### Quorum TLS
 #### Quorum TLS

+ 3 - 15
zookeeper-docs/src/main/resources/markdown/zookeeperOver.md

@@ -133,8 +133,7 @@ that restricts who can do what.
 
 
 ZooKeeper also has the notion of ephemeral nodes. These znodes
 ZooKeeper also has the notion of ephemeral nodes. These znodes
 exists as long as the session that created the znode is active. When the
 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]_.
+session ends the znode is deleted.
 
 
 <a name="Conditional+updates+and+watches"></a>
 <a name="Conditional+updates+and+watches"></a>
 
 
@@ -145,8 +144,7 @@ Clients can set a watch on a znode. A watch will be triggered and
 removed when the znode changes. When a watch is triggered, the client
 removed when the znode changes. When a watch is triggered, the client
 receives a packet saying that the znode has changed. If the
 receives a packet saying that the znode has changed. If the
 connection between the client and one of the ZooKeeper servers is
 connection between the client and one of the ZooKeeper servers is
-broken, the client will receive a local notification. These can be used
-to _[tbd]_.
+broken, the client will receive a local notification.
 
 
 <a name="Guarantees"></a>
 <a name="Guarantees"></a>
 
 
@@ -167,9 +165,6 @@ synchronization, it provides a set of guarantees. These are:
 * Timeliness - The clients view of the system is guaranteed to
 * Timeliness - The clients view of the system is guaranteed to
   be up-to-date within a certain time bound.
   be up-to-date within a certain time bound.
 
 
-For more information on these, and how they can be used, see
-_[tbd]_
-
 <a name="Simple+API"></a>
 <a name="Simple+API"></a>
 
 
 ### Simple API
 ### Simple API
@@ -199,10 +194,6 @@ operations:
 * *sync* :
 * *sync* :
     waits for data to be propagated
     waits for data to be propagated
 
 
-For a more in-depth discussion on these, and how they can be used
-to implement higher level operations, please refer to
-_[tbd]_
-
 <a name="Implementation"></a>
 <a name="Implementation"></a>
 
 
 ### Implementation
 ### Implementation
@@ -249,10 +240,7 @@ state.
 
 
 The programming interface to ZooKeeper is deliberately simple.
 The programming interface to ZooKeeper is deliberately simple.
 With it, however, you can implement higher order operations, such as
 With it, however, you can implement higher order operations, such as
-synchronizations primitives, group membership, ownership, etc. Some
-distributed applications have used it to: _[tbd: add uses from
-white paper and video presentation.]_ For more information, see
-_[tbd]_
+synchronizations primitives, group membership, ownership, etc.
 
 
 <a name="Performance"></a>
 <a name="Performance"></a>
 
 

+ 2 - 43
zookeeper-docs/src/main/resources/markdown/zookeeperProgrammers.md

@@ -50,11 +50,6 @@ limitations under the License.
 * [Building Blocks: A Guide to ZooKeeper Operations](#ch_guideToZkOperations)
 * [Building Blocks: A Guide to ZooKeeper Operations](#ch_guideToZkOperations)
     * [Handling Errors](#sc_errorsZk)
     * [Handling Errors](#sc_errorsZk)
     * [Connecting to ZooKeeper](#sc_connectingToZk)
     * [Connecting to ZooKeeper](#sc_connectingToZk)
-    * [Read Operations](#sc_readOps)
-    * [Write Operations](#sc_writeOps)
-    * [Handling Watches](#sc_handlingWatches)
-    * [Miscellaneous ZooKeeper Operations](#sc_miscOps)
-* [Program Structure, with Simple Example](#ch_programStructureWithExample)
 * [Gotchas: Common Problems and Troubleshooting](#ch_gotchas)
 * [Gotchas: Common Problems and Troubleshooting](#ch_gotchas)
 
 
 <a name="_introduction"></a>
 <a name="_introduction"></a>
@@ -82,8 +77,6 @@ information. These are:
 
 
 * [Building Blocks: A Guide to ZooKeeper Operations](#ch_guideToZkOperations)
 * [Building Blocks: A Guide to ZooKeeper Operations](#ch_guideToZkOperations)
 * [Bindings](#ch_bindings)
 * [Bindings](#ch_bindings)
-* [Program Structure, with Simple Example](#ch_programStructureWithExample)
-  _[tbd]_
 * [Gotchas: Common Problems and Troubleshooting](#ch_gotchas)
 * [Gotchas: Common Problems and Troubleshooting](#ch_gotchas)
 
 
 The book concludes with an [appendix](#apx_linksToOtherInfo) containing links to other
 The book concludes with an [appendix](#apx_linksToOtherInfo) containing links to other
@@ -92,10 +85,7 @@ useful, ZooKeeper-related information.
 Most of the information in this document is written to be accessible as
 Most of the information in this document is written to be accessible as
 stand-alone reference material. However, before starting your first
 stand-alone reference material. However, before starting your first
 ZooKeeper application, you should probably at least read the chapters on
 ZooKeeper application, you should probably at least read the chapters on
-the [ZooKeeper Data Model](#ch_zkDataModel) and [ZooKeeper Basic Operations](#ch_guideToZkOperations). Also,
-the [Simple Programming
-Example](#ch_programStructureWithExample) _[tbd]_ is helpful for understanding the basic
-structure of a ZooKeeper client application.
+the [ZooKeeper Data Model](#ch_zkDataModel) and [ZooKeeper Basic Operations](#ch_guideToZkOperations).
 
 
 <a name="ch_zkDataModel"></a>
 <a name="ch_zkDataModel"></a>
 
 
@@ -136,8 +126,7 @@ For instance, whenever a client retrieves data, it also receives the
 version of the data. And when a client performs an update or a delete,
 version of the data. And when a client performs an update or a delete,
 it must supply the version of the data of the znode it is changing. If
 it must supply the version of the data of the znode it is changing. If
 the version it supplies doesn't match the actual version of the data,
 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...]_
+the update will fail. (This behavior can be overridden.
 
 
 ######Note
 ######Note
 
 
@@ -1114,7 +1103,6 @@ ZooKeeper does _not_ in fact make. This is:
     primitives can be used to construct higher level functions that
     primitives can be used to construct higher level functions that
     provide useful client synchronization. (For more information,
     provide useful client synchronization. (For more information,
     see the [ZooKeeper Recipes](recipes.html).
     see the [ZooKeeper Recipes](recipes.html).
-    _[tbd:..]_).
 
 
 <a name="ch_bindings"></a>
 <a name="ch_bindings"></a>
 
 
@@ -1431,28 +1419,6 @@ Run the client.
 
 
 From the output, you should see "Connected to Zookeeper" along with Zookeeper's DEBUG messages if the connection is successful.
 From the output, you should see "Connected to Zookeeper" along with Zookeeper's DEBUG messages if the connection is successful.
 
 
-<a name="sc_readOps"></a>
-
-### Read Operations
-
-<a name="sc_writeOps"></a>
-
-### Write Operations
-
-<a name="sc_handlingWatches"></a>
-
-### Handling Watches
-
-<a name="sc_miscOps"></a>
-
-### Miscelleaneous ZooKeeper Operations
-
-<a name="ch_programStructureWithExample"></a>
-
-## Program Structure, with Simple Example
-
-_[tbd]_
-
 <a name="ch_gotchas"></a>
 <a name="ch_gotchas"></a>
 
 
 ## Gotchas: Common Problems and Troubleshooting
 ## Gotchas: Common Problems and Troubleshooting
@@ -1509,10 +1475,6 @@ ZooKeeper users fall into:
 Outside the formal documentation, there're several other sources of
 Outside the formal documentation, there're several other sources of
 information for ZooKeeper developers.
 information for ZooKeeper developers.
 
 
-* *ZooKeeper Whitepaper _[tbd: find url]_* :
-    The definitive discussion of ZooKeeper design and performance,
-    by Yahoo! Research
-
 * *[API Reference](https://zookeeper.apache.org/doc/current/api/index.html)* :
 * *[API Reference](https://zookeeper.apache.org/doc/current/api/index.html)* :
     The complete reference to the ZooKeeper API
     The complete reference to the ZooKeeper API
 
 
@@ -1532,6 +1494,3 @@ information for ZooKeeper developers.
     synchronization solutions with ZooKeeper: Event Handles, Queues,
     synchronization solutions with ZooKeeper: Event Handles, Queues,
     Locks, and Two-phase Commits.
     Locks, and Two-phase Commits.
 
 
-* *_[tbd]_* :
-    Any other good sources anyone can think of...
-

+ 0 - 2
zookeeper-docs/src/main/resources/markdown/zookeeperStarted.md

@@ -368,6 +368,4 @@ greatly increase performance:
   snapshots and _myid_ file. The dataLogDir
   snapshots and _myid_ file. The dataLogDir
   parameters indicates a different directory to use for the
   parameters indicates a different directory to use for the
   transaction logs.
   transaction logs.
-* _[tbd: what is the other config param?]_
-