hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hadoop QA (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HADOOP-9432) Add support for markdown .md files in site documentation
Date Mon, 25 Mar 2013 18:13:15 GMT

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

Hadoop QA commented on HADOOP-9432:

{color:green}+1 overall{color}.  Here are the results of testing the latest attachment 
  against trunk revision .

    {color:green}+1 @author{color}.  The patch does not contain any @author tags.

    {color:green}+0 tests included{color}.  The patch appears to be a documentation patch
that doesn't require tests.

    {color:green}+1 javac{color}.  The applied patch does not increase the total number of
javac compiler warnings.

    {color:green}+1 javadoc{color}.  The javadoc tool did not generate any warning messages.

    {color:green}+1 eclipse:eclipse{color}.  The patch built with eclipse:eclipse.

    {color:green}+1 findbugs{color}.  The patch does not introduce any new Findbugs (version
1.3.9) warnings.

    {color:green}+1 release audit{color}.  The applied patch does not increase the total number
of release audit warnings.

    {color:green}+1 core tests{color}.  The patch passed unit tests in .

    {color:green}+1 contrib tests{color}.  The patch passed contrib unit tests.

Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/2362//testReport/
Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/2362//console

This message is automatically generated.
> Add support for markdown .md files in site documentation
> --------------------------------------------------------
>                 Key: HADOOP-9432
>                 URL: https://issues.apache.org/jira/browse/HADOOP-9432
>             Project: Hadoop Common
>          Issue Type: New Feature
>          Components: build, documentation
>    Affects Versions: 3.0.0
>            Reporter: Steve Loughran
>            Priority: Minor
>         Attachments: HADOOP-9432.patch
>   Original Estimate: 0.5h
>  Remaining Estimate: 0.5h
> The "markdown" syntax for marking up text is something which the {{mvn site}} build can
be set up to support alongside the existing APT formatted text.
> Markdown offers many advantages
>  # It's more widely understood.
>  # There's tooling support in various text editors (TextMate, an IDEA plugin and others)
>  # It can be directly rendered in github
>  # the {{.md}} files can be named {{.md.vm}} to trigger velocity preprocessing, at the
expense of direct viewing in github
> feature #3 is good as it means that you can point people directly at a doc via a github
mirror, and have it rendered. 
> I propose adding the options to Maven to enable content be written as {{.md}} and {{.md.vm}}
files in the directory {{src/site/markdown}}. This does not require any changes to the existing
{{.apt}} files, which can co-exist and cross-reference each other.

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

View raw message