[
https://issues.apache.org/jira/browse/KAFKA-3361?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15188723#comment-15188723
]
ASF GitHub Bot commented on KAFKA-3361:
---------------------------------------
GitHub user granthenke opened a pull request:
https://github.com/apache/kafka/pull/1038
KAFKA-3361: Initial protocol documentation page and generation (0.9)
- Moves all generated docs under /docs/generated
- Generates docs for Protocol, Errors, and ApiKeys
- Adds new protocol.html page
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/granthenke/kafka protocol-docs-0.9
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/kafka/pull/1038.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1038
----
commit c0754edb2f3ef85980a56f45430d1f7ba6c0ab76
Author: Grant Henke <[email protected]>
Date: 2016-03-10T05:43:13Z
KAFKA-3361: Initial protocol documentation page and generation
- Moves all generated docs under /docs/generated
- Generates docs for Protocol, Errors, and ApiKeys
- Adds new protocol.html page
----
> Initial protocol documentation page and generation
> --------------------------------------------------
>
> Key: KAFKA-3361
> URL: https://issues.apache.org/jira/browse/KAFKA-3361
> Project: Kafka
> Issue Type: Sub-task
> Reporter: Grant Henke
> Assignee: Grant Henke
> Fix For: 0.10.0.0
>
>
> Add an initial rough draft page to the official documentation. The output
> will be mostly generated from code, ensuring the docs are accurate and up to
> date. This is likely to be a separate page due to the size of the content.
> The idea here is that something is better than nothing. Other jiras will
> track needed improvements.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
