[ 
https://issues.apache.org/jira/browse/ZOOKEEPER-918?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12932902#action_12932902
 ] 

Flavio Junqueira commented on ZOOKEEPER-918:
--------------------------------------------

Amit, just to give you an update, we have been discussing switching to a new 
documentation system soon (ZOOKEEPER-925), so we were wondering if it would be 
a problem waiting until we have it. Assuming the new system is easier to work 
with, we can more easily introduce your notes to the release documentation. 
Does it sound ok? 

If we take too long, then we can rethink it and find another way, like creating 
a wiki page or committing the pdf directly and linking to the BK documentation.

> 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
>            Assignee: Amit Jaiswal
>            Priority: Minor
>             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.

Reply via email to