hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Allen Wittenauer (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (HADOOP-9432) Add support for markdown .md files in site documentation
Date Fri, 12 Feb 2016 19:50:18 GMT

     [ https://issues.apache.org/jira/browse/HADOOP-9432?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel

Allen Wittenauer updated HADOOP-9432:
    Assignee: Steve Loughran

> 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
>            Assignee: Steve Loughran
>            Priority: Minor
>             Fix For: 2.3.0
>         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 was sent by Atlassian JIRA

View raw message