[jira] [Commented] (YARN-437) Update documentation of "Writing Yarn Applications" to match current best practices

["Steve Loughran (JIRA)" <ji...@apache.org>]

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

Steve Loughran commented on YARN-437:
-------------------------------------

looks OK, even though git wouldn't apply the patch for me, {{error: hadoop-yarn/hadoop-yarn-site/src/site/apt/WritingYarnApplications.apt.vm: No such file or directory}}; even though the diff is off the root path.

Referring the user to the DistShell example is good for completeness and to avoid the docs from ever getting out of sync. But it adds a requirement to "go and find that source". It's a pity there's no way to do a github gist-style insertion in the .apt file, but maybe it'd be possible to point to SVN. Only: how to keep that link in sync with different source versions.

# consider using MUST over SHOULD, e.g. in return codes.
# some of the (old, preserved) text doesn't << >> enough of the references to variables & other code fragments in the text. A doc update is the time to review this. 


                
> Update documentation of "Writing Yarn Applications" to match current best practices
> -----------------------------------------------------------------------------------
>
>                 Key: YARN-437
>                 URL: https://issues.apache.org/jira/browse/YARN-437
>             Project: Hadoop YARN
>          Issue Type: Bug
>          Components: documentation
>            Reporter: Hitesh Shah
>            Assignee: Eli Reisman
>         Attachments: YARN-437-1.patch, YARN-437-2.patch, YARN-437-3.patch
>
>
> Should fix docs to point to usage of YarnClient and AMRMClient helper libs. 

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira