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

Chris Nauroth commented on HADOOP-11031:
----------------------------------------

Darn, I cannot find a way to make Markdown hyperlink straight to the 
{{getPassword}} method.  It doesn't like the parentheses nested in the URL.

file:///private/tmp/hadoop-site/hadoop-project/api/org/apache/hadoop/conf/Configuration.html#getPassword(java.lang.String)

I tried all sorts of crazy escaping and even URL-encoding the parens, but 
nothing worked.

It appears we've struggled with this before.  The WebHDFS documentation has 
taken the approach of only linking to the top-level class and not the 
individual method.  For example, see the link to FileSystem.create here:

http://hadoop.apache.org/docs/r2.7.2/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Create_and_Write_to_a_File

I guess we could switch to that style so that it's consistent.  The Markdown 
would look like this:

{code}
[Configuration](../../api/org/apache/hadoop/conf/Configuration.html).getPassword
{code}

I'll be +1 after that change.  Thank you, Larry!

> Design Document for Credential Provider API
> -------------------------------------------
>
>                 Key: HADOOP-11031
>                 URL: https://issues.apache.org/jira/browse/HADOOP-11031
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: site
>            Reporter: Larry McCay
>            Assignee: Larry McCay
>         Attachments: CredentialProviderAPI.md, HADOOP-11031-001.patch, 
> HADOOP-11031-002.patch, HADOOP-11031-003.patch
>
>
> Provide detailed overview of the design, intent and use of the credential 
> management API.



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

Reply via email to