hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Andy Isaacson (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HADOOP-8427) Convert Forrest docs to APT
Date Thu, 18 Oct 2012 01:28:03 GMT

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

Andy Isaacson commented on HADOOP-8427:
---------------------------------------

bq. Hi Andy, could we first remove the out-of-date doc and then convert it to APT? It would
be much easier to see the changes.

I'm not sure what you're asking for, could you be more specific?

Since all the filenames and all the content is changing, this diff is going to be monstrous
in any case.  I can post a separate "here's the rm command to run" and then a "here's the
new markup", but the new markup (in APT) is completely different from the old markup (in Forrest
XML).

Pages that I'm planning to convert and fully update to 2.0:

http://hadoop.apache.org/docs/r1.0.3/file_system_shell.html
http://hadoop.apache.org/docs/r1.0.3/commands_manual.html

Pages that I'm planning to convert without editing for 2.0 content:

http://hadoop.apache.org/docs/r1.1.0/mapred_tutorial.html
http://hadoop.apache.org/docs/r1.0.3/cluster_setup.html
http://hadoop.apache.org/docs/r1.0.3/deployment_layout.html
http://hadoop.apache.org/docs/r1.0.3/native_libraries.html
http://hadoop.apache.org/docs/r1.0.3/service_level_auth.html
http://hadoop.apache.org/docs/r1.0.3/cluster_setup.html

Pages that I'm planning to delete as no longer relevant:

http://hadoop.apache.org/docs/r1.0.3/HttpAuthentication.html

I've moved mapred\_tutorial and cluster\_setup from "plan to delete" to "plan to convert without
editing" since my last comment.  I'm not sure if HttpAuthentication is salvageable, would
appreciate input on that.  In any case, it's fairly easy to resurrect a page.

In fact, I suppose the right thing is simply to leave xdocs/*.xml in place (unused), adding
apt.vm versions as they're converted, then deleting the unused .xml after they are completely
redundant.  I'll post a new patch to that effect.
                
> Convert Forrest docs to APT
> ---------------------------
>
>                 Key: HADOOP-8427
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8427
>             Project: Hadoop Common
>          Issue Type: Task
>          Components: documentation
>    Affects Versions: 2.0.0-alpha
>            Reporter: Eli Collins
>            Assignee: Andy Isaacson
>              Labels: newbie
>         Attachments: hadoop8427.txt
>
>
> Some of the forrest docs content in src/docs/src/documentation/content/xdocs has not
yet been converted to APT and moved to src/site/apt. Let's convert the forrest docs that haven't
been converted yet to new APT content in hadoop-common/src/site/apt (and link the new content
into hadoop-project/src/site/apt/index.apt.vm) and remove all forrest dependencies.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message