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

Wangda Tan commented on YARN-8875:
----------------------------------

Thanks [~liuxun323]. 

More comments: 
1) Inside Index.md, should remove "Installation guide" / "Installation guide 
Chinese version" and link to HowToInstall.html. 

2) There're many links use .md, how ever, since Hadoop generates html link, you 
should use .html instead, like. 
{code}
[EN](InstallationGuide.md)  # you should use ...html
{code}

3) The image link doesn't work after doc generated. 
You should put it under resources/images like other images. Example: 
{code}
...
See below screenshot:
![alt text](./images/tensorboard-service.png "Tensorboard service")
...
{code}

4) Test site. 
You can use following command to test site:
{code}
mvn clean site:site -Preleasedocs; mvn site:stage 
-DstagingDirectory=/tmp/hadoop-site
{code}

Once it finishes, you can open /tmp/hadoop-site/hadoop-project/index.html from 
your browser and check the doc. Submarine can be found from left nav panel. 

> [Submarine] Add documentation for submarine installation script details
> -----------------------------------------------------------------------
>
>                 Key: YARN-8875
>                 URL: https://issues.apache.org/jira/browse/YARN-8875
>             Project: Hadoop YARN
>          Issue Type: Sub-task
>            Reporter: Xun Liu
>            Assignee: Xun Liu
>            Priority: Critical
>         Attachments: YARN-8875.001.patch, YARN-8875.002.patch, 
> YARN-8875.003.patch, YARN-8875.004.patch
>
>
> YARN-8870: submarine installation guide



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

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to