hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Colin Patrick McCabe (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HADOOP-11495) Convert site documentation from apt to markdown
Date Thu, 19 Feb 2015 03:19:12 GMT

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

Colin Patrick McCabe commented on HADOOP-11495:
-----------------------------------------------

[~aw], I understand your concerns about documentation changes from trunk getting into branch-2
accidentally through a backport.  You can help address that concern by doing a review of the
branch-2 patches that [~iwasakims] and I have posted and/or filing follow-up JIRAs for any
issues you find.

It is not fair to ask someone doing a simple docs change intended for a stable release to
do it twice over (once for markdown in trunk, and another time in .apt.vm for branch-2.) 
We already have a problem keeping documentation current.  Dumping more work on documentation
authors is the exact opposite of what we should be doing and effectively negates any benefit
this may have (in fact, the patch has negative benefit in this case).  Please keep in mind
that there is no Hadoop 3.x release yet.  Since Apache is about releasing software, branch-2
is still at the core of what we are doing as an organization.

bq. To that end, I'd much prefer if you decided to do this work in another JIRA given that
this one was always specifically targeted to trunk and was never intended for branch-2. Never
mind the fact that frankly I don't want my name associated with your patch.

We've almost always done backports on the same JIRA as the original work.  If you'd like to
change that practice, then start a discussion thread in hdfs-devel.

Anyway, I am +1 on [~iwasakims]'s patch.  I will wait a few hours before committing in case
there are more comments.

> 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
>            Assignee: Masatake Iwasaki
>             Fix For: 3.0.0
>
>         Attachments: HADOOP-11495-02.patch, HADOOP-11495-03.patch, HADOOP-11495-04.patch,
HADOOP-11495-05.patch, HADOOP-11495-b2.001.patch, HADOOP-11495-b2.002.patch, 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)

Mime
View raw message