[ 
https://issues.apache.org/jira/browse/HDFS-14410?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16881784#comment-16881784
 ] 

Yiqun Lin edited comment on HDFS-14410 at 7/10/19 12:15 PM:
------------------------------------------------------------

Thanks for adding the doc for Dynamometer, [~xkrogen]!

The content looks almost good. Regarding this as a tool document, I have some 
minor suggestions.
 * For the content of the tool usage, I prefer to additionally add some words 
like step1, step2.. in section title that will let user know the order of the 
execute operations.
 E.g. "Preparing Requisite Files" update to "Step 1: Preparing Requisite Files"

 * Can we add one additional section to describe some contents about the 
architecture of Dynamometer. In this section, some related architecture image 
files can also be displayed in. I remember there is one linkedin page that 
detailed described the architecture of this. We can move some content to here.

 

For the page rendering, can you use mvn site command to have a check? It will 
generate the html file in the target location. Following step you can have a 
try and then please attach the screen shot of the generated page if you try 
succeed:
 * cd hadoop-tools/hadoop-dynamometer
 * run mvn site:site
 * open the page hadoop-tools/hadoop-dynamometer/target/site/Dynamometer.html 
to have a check


was (Author: linyiqun):
Thanks for adding the doc for Dynamometer. Can you use mvn site command to have 
a check? It will generate the html file in the target location. Following step 
you can have a try:
 * cd hadoop-tools/hadoop-dynamometer
 * run mvn site:site
 * open the page hadoop-tools/hadoop-dynamometer/target/site/Dynamometer.html 
to have a check

> Make Dynamometer documentation properly compile onto the Hadoop site
> --------------------------------------------------------------------
>
>                 Key: HDFS-14410
>                 URL: https://issues.apache.org/jira/browse/HDFS-14410
>             Project: Hadoop HDFS
>          Issue Type: Sub-task
>            Reporter: Erik Krogen
>            Assignee: Erik Krogen
>            Priority: Major
>         Attachments: HDFS-14410.000.patch
>
>
> The documentation included with Dynamometer doesn't properly appear on the 
> site, we need to twiddle with this a bit.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org

Reply via email to