[
https://issues.apache.org/jira/browse/ZOOKEEPER-918?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12928697#action_12928697
]
Patrick Hunt commented on ZOOKEEPER-918:
----------------------------------------
There are really two options for docs (today):
1) put it into svn as a forrest doc. typically this is for documentation that's
version specific - needs to be versioned along with the code
2) put it into wiki, usually this is non-version specific detail.
putting into svn requires a patch for each change, which adds to the overhead.
another way to go is to start on the wiki, once the doc is fairly stable move
it to svn.
> Review of BookKeeper Documentation (Sequence flow and failure scenarios)
> ------------------------------------------------------------------------
>
> Key: ZOOKEEPER-918
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-918
> Project: Zookeeper
> Issue Type: Task
> Components: documentation
> Reporter: Amit Jaiswal
> Priority: Trivial
> Fix For: 3.3.3, 3.4.0
>
> Attachments: BookKeeperInternals.doc, BookKeeperInternals.pdf
>
> Original Estimate: 2h
> Remaining Estimate: 2h
>
> I have prepared a document describing some of the internals of bookkeeper in
> terms of:
> 1. Sequence of operations
> 2. Files layout
> 3. Failure scenarios
> The document is prepared by mostly by reading the code. Can somebody who
> understands the design review the same.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
