Github user hanm commented on the issue:
https://github.com/apache/zookeeper/pull/274
@bensherman
Actually there is one issue in this PR that I missed until I reviewed
another PR today - the documentation change should be applied to the document
*source* instead of generated document artifacts. Just to copy and paste what I
commented in another PR:
>>Please don't directly modify the document artifacts (html files, etc).
The way the document is updated is by modifying the source of the docs, located
at src/docs/src/documentation/content/xdocs. After modifying the source, please
verify the generated document is correct locally by using apache forrest
https://forrest.apache.org/. After verification please submit the document
source change only - the compiled document artifacts (html files, etc) don't
need to be submitted, because we will regenerate document in every release.
Please check the commit history of
https://github.com/apache/zookeeper/tree/master/src/docs/src/documentation/content/xdocs
to get a concrete idea of how to make doc changes, it should be pretty
straightforward.
In addition, as I commented on the JIRA, it would be great to have this
feature in branch-3.5 and master also. Would you be willing to send PRs target
those branches? I am happy to review and merge them.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
