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] [Commented] (HADOOP-11495) Convert site documentation from apt to markdown
Date Mon, 26 Jan 2015 20:45:36 GMT

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

Allen Wittenauer commented on HADOOP-11495:
-------------------------------------------

bq. Somewhere around 60kb would be fine. A patch per-project should be fine too. 

To put this into perspective, this patch currently converts the following files:

{code}
$ du -sh hadoop-common/src/site/apt/*
4.0K	hadoop-common/src/site/apt/CLIMiniCluster.apt.vm
 32K	hadoop-common/src/site/apt/ClusterSetup.apt.vm
 16K	hadoop-common/src/site/apt/CommandsManual.apt.vm
 24K	hadoop-common/src/site/apt/Compatibility.apt.vm
 24K	hadoop-common/src/site/apt/DeprecatedProperties.apt.vm
 24K	hadoop-common/src/site/apt/FileSystemShell.apt.vm
8.0K	hadoop-common/src/site/apt/HttpAuthentication.apt.vm
 12K	hadoop-common/src/site/apt/InterfaceClassification.apt.vm
 56K	hadoop-common/src/site/apt/Metrics.apt.vm
8.0K	hadoop-common/src/site/apt/NativeLibraries.apt.vm
8.0K	hadoop-common/src/site/apt/RackAwareness.apt.vm
 40K	hadoop-common/src/site/apt/SecureMode.apt.vm
 12K	hadoop-common/src/site/apt/ServiceLevelAuth.apt.vm
8.0K	hadoop-common/src/site/apt/SingleCluster.apt.vm
4.0K	hadoop-common/src/site/apt/SingleNodeSetup.apt.vm
8.0K	hadoop-common/src/site/apt/Superusers.apt.vm
8.0K	hadoop-common/src/site/apt/Tracing.apt.vm
{code}

... in other words, the core part of hadoop-common-project.

60k would mean splitting this up into approx 8-9 different patches.  

> 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-11495-02.patch, HADOOP-11495-03.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