[
https://issues.apache.org/jira/browse/HADOOP-11495?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14284896#comment-14284896
]
Allen Wittenauer commented on HADOOP-11495:
-------------------------------------------
bq. Are we at all worried about the lack of standardization in Markdown?
I actually did some looking into this since we're sort of beholden to Maven.
* We're not actually using that many fancy things. The biggest problems are
table of contents and tables. Lists (numbered or otherwise) are surprisingly
rare vs tables.
* Maven's markdown support is pretty much the same as github's markdown support
as far as extensions are concerned.
It's probably worth pointing out that we've already got some markdown in the
tree.
bq. it is preferable to change all sub-projects in the same release.
I was planning on doing them all, depending upon how this JIRA goes.
Additionally, we're not in a "do or die" situation like we were with forrest,
so we can do this more piecemeal, hopefully spreading the proofreading load
around a bit. In turn, this will hopefully prevent the problems that the
forrest -> apt conversion hit (such as the complete mess that ClusterSetup
ended up.. and still is in branch-2. I've since fixed it in trunk).
> 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
> Affects Versions: 3.0.0
> Reporter: Allen Wittenauer
> Attachments: HADOOP-11496-00.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)
