[
https://issues.apache.org/jira/browse/HADOOP-11495?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14287928#comment-14287928
]
Allen Wittenauer commented on HADOOP-11495:
-------------------------------------------
Here is something to consider:
Anything that uses the Velocity engine to render maven specific bits (such as
${project.version}) will need to be named .md.vm. This means they won't render
on github.
Option 1: Strip as much of the maven build stuff out so that we get github
rendering on those pages that don't *absolutely* need those vars. For the ones
that do need them (e.g., anything referencing the mapreduce examples jar), only
keep them named .md.vm
Option 2: Name everything .md.vm and therefore have zero rendering on github?
> Convert site documentation from apt to markdown
> -----------------------------------------------
>
> Key: HADOOP-11495
> URL: https://issues.apache.org/jira/browse/HADOOP-11495
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 3.0.0
> Reporter: Allen Wittenauer
> Attachments: HADOOP-11496-00.patch, HADOOP-11496-01.patch
>
>
> Almost Plain Text (aka APT) lost. Markdown won.
> As a result, there are a ton of tools and online resources for Markdown that
> would make editing and using our documentation much easier. It would be
> extremely beneficial for the community as a whole to move from apt to
> markdown.
> This JIRA proposes to do this migration for the common project.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
