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

Allen Wittenauer commented on HADOOP-11553:
-------------------------------------------

Couple of other things:
* the md maker obviously needs some header and footer stuff as well as taking a 
parameter of the shell code to actually process
* I've uploaded sample output here: 
https://github.com/aw-altiscale/hadoop-release-metadata/blob/master/3.0.0/shellfunctions.md
 of the current documentation that is generated.  It's not GREAT! but better 
than what we had. :D

> Formalize the shell API
> -----------------------
>
>                 Key: HADOOP-11553
>                 URL: https://issues.apache.org/jira/browse/HADOOP-11553
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation, scripts
>    Affects Versions: 3.0.0
>            Reporter: Allen Wittenauer
>            Assignee: Allen Wittenauer
>            Priority: Blocker
>         Attachments: HADOOP-11553-00.patch, HADOOP-11553-01.patch, 
> HADOOP-11553-02.patch
>
>
> After HADOOP-11485, we need to formally document functions and environment 
> variables that 3rd parties can expect to be able to exist/use.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to