[
https://issues.apache.org/jira/browse/KAFKA-3480?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15231477#comment-15231477
]
ASF GitHub Bot commented on KAFKA-3480:
---------------------------------------
GitHub user wushujames opened a pull request:
https://github.com/apache/kafka/pull/1202
[WIP] KAFKA-3480: Autogenerate metrics documentation
This is a proof of concept for autogenerating documentation for metrics, to
see whether this approach is feasible.
I applied it to the metrics in the TestMetrics.java file. I will attach the
generated file to the JIRA, for reference.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/wushujames/kafka metrics_docs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/kafka/pull/1202.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 #1202
----
commit af70dc2f62897745d86169d900df4b6fe39c9d6b
Author: James Cheng <[email protected]>
Date: 2016-04-08T01:35:10Z
Proof of concept for auto generating metrics documentation.
commit d01b49894f82c90de41fa5992b50c71b8b1ed717
Author: James Cheng <[email protected]>
Date: 2016-04-08T01:36:52Z
Merge remote-tracking branch 'origin/trunk' into metrics_docs
----
> Autogenerate metrics documentation
> ----------------------------------
>
> Key: KAFKA-3480
> URL: https://issues.apache.org/jira/browse/KAFKA-3480
> Project: Kafka
> Issue Type: Improvement
> Reporter: Jason Gustafson
>
> Metrics documentation is done manually, which means it's hard to keep it
> current. It would be nice to have automatic generation of this documentation
> as we have for configs.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
