Hi Zhanhui,
Thanks for preparing the contents! It is a very important section.
I would make it a section of "Coding Guidelines" we already have (No
introduction is needed, it's pretty obvious why comments are needed :) )"Coding
Guidelines" are referred from "Best Practice in PR", and thus having
documentation becomes a necessary condition for PR submission.
Roman
On Wednesday, March 1, 2017 5:49 PM, Zhanhui Li <[email protected]> wrote:
Hi All,
True that Apache RocketMQ excels in many places, but it still needs as many
efforts to be good enough. Documentation, IMO, is a one of the efforts that
requires prior attention.
Generally speaking, two categories of documentation are needed: One is user
oriented documentation showing how to use Apache RocketMQ effectively,
following known best practices; the other is codebase documentation, which
would substantially lower threshold joining and contributing after the codebase
is fully annotated in javadoc.
I just composed/committed a documentation guideline here:
https://github.com/apache/incubator-rocketmq-site/blob/master/_docs/07-documentation.md
<https://github.com/apache/incubator-rocketmq-site/blob/master/_docs/07-documentation.md>
(not published to our website yet), wishing to establish some rules for the
incoming documentation work and contribution. You guys are welcome to comment
and advise.
Zhanhui Li
