[
https://issues.apache.org/jira/browse/HDFS-10678?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Mingliang Liu updated HDFS-10678:
---------------------------------
Attachment: HDFS-10678.002.patch
The v2 patch is to address [~iwasakims]'s last comment. Thanks for the
suggestion.
{quote}
I think Benchmarking.md should be just toc and the doc of NNThroughputBenchmakr
should be under hadoop-hdfs-project/hadoop-hdfs/src/site as independent page.
{quote}
Adding a toc file seems good for long term, but a bit heavy/overkill because it
will have only one link as content as the only benchmarking related material by
now is {{NNThroughputBenchmark}}.
Does it make sense to add a new *menu* for the
hadoop-project/src/site/site.xml? In this way, we organize all benchmarking
related pages in one section, while keep themselves independent and well placed.
> Documenting NNThroughputBenchmark tool
> --------------------------------------
>
> Key: HDFS-10678
> URL: https://issues.apache.org/jira/browse/HDFS-10678
> Project: Hadoop HDFS
> Issue Type: Sub-task
> Components: benchmarks, test
> Reporter: Mingliang Liu
> Assignee: Mingliang Liu
> Labels: documentation
> Attachments: HDFS-10678.000.patch, HDFS-10678.001.patch,
> HDFS-10678.002.patch
>
>
> The best (only) documentation for the NNThroughputBenchmark currently exists
> as a JavaDoc on the NNThroughputBenchmark class. This is less than useful,
> especially since we no longer generate javadocs for HDFS as part of the build
> process. I suggest we extract it into a separate markdown doc, or merge it
> with other benchmarking materials (if any?) about HDFS.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
