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

Andrew Wang commented on HADOOP-10922:
--------------------------------------

Thanks Larry, this is a nice start. I foresee this moving into the design doc 
when it's ready and simply linking to that, sorta like the Hadoop archive 
section in the command manual. However, we can get this committed first if you 
like, and move it over later in HADOOP-11031.

A few review comments:

* Rather than ending with "by them", better to flip it to "separation of 
applications and how they store their required passwords and secrets".
* "CredentialProvider API" rather than "credential provider API"
* "hadoop" should be capitalized
* I like to monospace everything that's part of a CLI command, a file path, 
hostname, config option, etc. We can skip doing it for the first column of the 
table, but I think it should apply everywhere else.
* The "Usage" needs to be adjusted, since we have a number of suboptions that 
are exclusive, e.g. you can't specify both {{-create}} and {{-delete}} at the 
same time. Maybe better to just say {{<subcommand>}}, and rely on the table.
* "comma separated" -> "comma-separated"
* "url" should be all caps
* What does "comma separated list of url syntax" mean? Should this say 
"comma-separated list of URIs"?
* Is only the first provider consulted? That's what the example's descriptive 
text seems to indicate.

> User documentation for CredentialShell
> --------------------------------------
>
>                 Key: HADOOP-10922
>                 URL: https://issues.apache.org/jira/browse/HADOOP-10922
>             Project: Hadoop Common
>          Issue Type: Improvement
>    Affects Versions: 2.6.0
>            Reporter: Andrew Wang
>            Assignee: Larry McCay
>         Attachments: HADOOP-10922-1.patch
>
>
> The CredentialShell needs end user documentation for the website.



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

Reply via email to