Status

Current state: "Under Discussion"

Discussion thread: N/A

JIRA: N/A

Released: N/A

Motivation

In general, bookkeeper doesn't have very good documentation. In 4.5.0, we tried to improve the documentation as rewriting the website using markdown syntax and building with jekyll. The documentation looks much better than before. But the documentation itself is still lagging behind.  There are a few major areas that requires contributions and improvements, such as `Usage` (Tutorials, Examples and such), `Deployment`, `Operations` (Administration), `Development` (Internals, code structures).

Proposed Changes

Currently the new bookkeeper website has good layout about sections, `Getting Started`, `Deployment`, `Administration`, `API`, `Security` and `Development`. This proposal will be based on current layout, adding two new sections and improving individual existing sections.

Existing Sections

Following are list of changes proposed for each section.

...

• 
  Fill up the details on `metrics` page

New Sections

Propose to add new sections:

• Performance: We can include the basic benchmark, how to run it, what is the results and include other reliability test results such as jepsen results.

Actions

This can be done by the collaboration in the community. We can create a master ticket and divide the work into individual sections and then divide into individual pages. Anyone who is willing to contribute to this can pick up an item and help fill up with content.

...