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 Wed, 18 Feb 2015 01:16:14 GMT

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

Colin Patrick McCabe commented on HADOOP-11495:

OK, I wrote a patch for branch-2.

* SingleCluster.md.vm: there were some differences in the branch-2 version which I forward-ported
on to the rebase.  Mostly "rsync" versus "pdsh", etc.

* FileSystemShell.md: there were a bunch of conversions from "hdfs dfs" -> "hadoop dfs"
in the trunk version.  I simply overwrote the branch-2 version since "hadoop dfs" is the correct
(non-deprecated) thing anyway.

* CommandsManual.md / ClusterSetup.md: looks like these whole files got rewritten (more or
less).  I just retained the old .apt.vm versions.  We can convert them later if needed.

I'd like to restate that we should not creating huge divergences between branch-2 and trunk
unless there is a very good reason.  We should try to keep this in mind in the future.  I
would certainly have vetoed this if I thought there was a chance that it would create a divergence
like that and I'm sure that a bunch of others feel the same way.

anyway the patch is up, let me know if there's anything more to do or else, I think we should
commit asap

> 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-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

View raw message