You are viewing a plain text version of this content. The canonical link for it is here.
Posted to mapreduce-issues@hadoop.apache.org by "Eli Collins (JIRA)" <ji...@apache.org> on 2012/05/23 19:33:41 UTC
[jira] [Created] (MAPREDUCE-4282) Convert Forrest docs to APT
Eli Collins created MAPREDUCE-4282:
--------------------------------------
Summary: Convert Forrest docs to APT
Key: MAPREDUCE-4282
URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
Project: Hadoop Map/Reduce
Issue Type: Task
Affects Versions: 2.0.0
Reporter: Eli Collins
MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13488813#comment-13488813 ]
Hadoop QA commented on MAPREDUCE-4282:
--------------------------------------
{color:red}-1 overall{color}. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12551725/bad-forrest2apt-attempt1.tar
against trunk revision .
{color:red}-1 patch{color}. The patch command could not apply the patch.
Console output: https://builds.apache.org/job/PreCommit-MAPREDUCE-Build/2976//console
This message is automatically generated.
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Eli Reisman
> Labels: newbie
> Attachments: bad-forrest2apt-attempt1.tar, MAPREDUCE-4282-1.patch, MAPREDUCE-4282-2.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
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
[jira] [Updated] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Eli Reisman (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Eli Reisman updated MAPREDUCE-4282:
-----------------------------------
Attachment: bad-forrest2apt-attempt1.tar
I found it! Its really attricious. I started out looking at only a subset of the docs I needed to translate and thought i could get away with "shortcuts", took a simple swipe at it, then kept plugging holes...You see what happened next. Ugh.
Anyway I'm in a compilers class now and am considering attempting again with lex/yacc or similar tool to maybe get this just right. If I have a minute coming up here I'll take a shot and put that up too. If someone else wants to make an attempt to fix the script as-is, feel free...and good luck.
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Eli Reisman
> Labels: newbie
> Attachments: bad-forrest2apt-attempt1.tar, MAPREDUCE-4282-1.patch, MAPREDUCE-4282-2.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
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
[jira] [Commented] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13424198#comment-13424198 ]
Hadoop QA commented on MAPREDUCE-4282:
--------------------------------------
-1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12538218/MAPREDUCE-4282-2.patch
against trunk revision .
+1 @author. The patch does not contain any @author tags.
-1 tests included. The patch doesn't appear to include any new or modified tests.
Please justify why no new tests are needed for this patch.
Also please list what manual steps were performed to verify this patch.
-1 javac. The patch appears to cause the build to fail.
Console output: https://builds.apache.org/job/PreCommit-MAPREDUCE-Build/2671//console
This message is automatically generated.
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Eli Reisman
> Labels: newbie
> Attachments: MAPREDUCE-4282-1.patch, MAPREDUCE-4282-2.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Tom White (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13464613#comment-13464613 ]
Tom White commented on MAPREDUCE-4282:
--------------------------------------
Thanks for looking at this Eli. I tried to build the site using
{noformat}
mvn clean site; mvn -o site:stage -DstagingDirectory=/tmp/hadoop-site
{noformat}
but I got
{noformat}
Error during page generation: Files 'apt/index.apt.vm' clashes with existing '/Users/tom/workspace/hadoop-trunk/hadoop-project/src/site/apt/index.apt'.
{noformat}
The index.apt file contains documentation about distcp, so it should be renamed or merged with distcp.apt. When I fixed that problem the build succeeded but the rendering of the files looked wrong - it just had the raw markup.
I noticed that you put all the files at the top-level rather than in modules (Common, HDFS, MapReduce). It probably makes sense to split them up more (see HADOOP-8860), although the links get a bit more complex in that case due to the way that Maven uses the POM hierarchy to create the structure.
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Eli Reisman
> Labels: newbie
> Attachments: MAPREDUCE-4282-1.patch, MAPREDUCE-4282-2.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
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
[jira] [Commented] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Eli Reisman (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13478014#comment-13478014 ]
Eli Reisman commented on MAPREDUCE-4282:
----------------------------------------
Let me see if I still have it, I wrote it on my old work machine...
I am hearing some other related docs do not render right with the script +
some hand-editing (the script was pretty hacky) so a re-think on this one
might be in order. I believe these docs were also run through the script
and then lightly hand-edited.
One issue I had was occasionally i did not find a matching APT notation to
render some of the tags from the Forrest docs and had to guess. Not that
thats the biggest problem with this translation ;)
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Eli Reisman
> Labels: newbie
> Attachments: MAPREDUCE-4282-1.patch, MAPREDUCE-4282-2.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
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
[jira] [Commented] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Andy Isaacson (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13477433#comment-13477433 ]
Andy Isaacson commented on MAPREDUCE-4282:
------------------------------------------
bq. Sorry, I used a script and the translation was not always perfect.
In the interests of posterity (and other poor souls who need to do this conversion), would you be willing to attach your script to this jira?
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Eli Reisman
> Labels: newbie
> Attachments: MAPREDUCE-4282-1.patch, MAPREDUCE-4282-2.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
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
[jira] [Assigned] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Jakob Homan (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jakob Homan reassigned MAPREDUCE-4282:
--------------------------------------
Assignee: Jakob Homan
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Jakob Homan
> Labels: newbie
> Attachments: MAPREDUCE-4282-1.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Eli Reisman (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Eli Reisman updated MAPREDUCE-4282:
-----------------------------------
Attachment: MAPREDUCE-4282-1.patch
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Labels: newbie
> Attachments: MAPREDUCE-4282-1.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Assigned] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Jakob Homan (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jakob Homan reassigned MAPREDUCE-4282:
--------------------------------------
Assignee: Eli Reisman (was: Jakob Homan)
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Eli Reisman
> Labels: newbie
> Attachments: MAPREDUCE-4282-1.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13423450#comment-13423450 ]
Hadoop QA commented on MAPREDUCE-4282:
--------------------------------------
-1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12538036/MAPREDUCE-4282-1.patch
against trunk revision .
+1 @author. The patch does not contain any @author tags.
-1 tests included. The patch doesn't appear to include any new or modified tests.
Please justify why no new tests are needed for this patch.
Also please list what manual steps were performed to verify this patch.
-1 javac. The patch appears to cause the build to fail.
Console output: https://builds.apache.org/job/PreCommit-MAPREDUCE-Build/2666//console
This message is automatically generated.
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Eli Reisman
> Labels: newbie
> Attachments: MAPREDUCE-4282-1.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Eli Reisman (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Eli Reisman updated MAPREDUCE-4282:
-----------------------------------
Attachment: MAPREDUCE-4282-2.patch
moved all the docs in hadoop-common/ that derive from any xdoc/ or xdocs/ forrest directories into site/apt/ as detailed in HADOOP-8427 and here.
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Eli Reisman
> Labels: newbie
> Attachments: MAPREDUCE-4282-1.patch, MAPREDUCE-4282-2.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Eli Reisman (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Eli Reisman updated MAPREDUCE-4282:
-----------------------------------
Status: Patch Available (was: Open)
added the apt files converted from xml and added the APT plugin to the pom.xml. This does not yet include config files for APT, if any are required, or default annotation processor. But its a start!
Used a script to do the docs, went through and tried to fix discrepancies.
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Labels: newbie
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MAPREDUCE-4282) Convert Forrest docs to APT
Posted by "Eli Reisman (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MAPREDUCE-4282?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13475977#comment-13475977 ]
Eli Reisman commented on MAPREDUCE-4282:
----------------------------------------
Sorry, I used a script and the translation was not always perfect. I tried to fix problems where i noticed them. I thought the tables would generate correctly in APT without having to format them perfectly in the .apt files as long as the number of table rows/columns stays consistent per-table, but that might not be the case.
I will take a look at this. Thanks for the review!
> Convert Forrest docs to APT
> ---------------------------
>
> Key: MAPREDUCE-4282
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-4282
> Project: Hadoop Map/Reduce
> Issue Type: Task
> Affects Versions: 2.0.0-alpha
> Reporter: Eli Collins
> Assignee: Eli Reisman
> Labels: newbie
> Attachments: MAPREDUCE-4282-1.patch, MAPREDUCE-4282-2.patch
>
>
> MR side of HADOOP-8427. Not all of the old forrest docs in src/documentation/content/xdocs have been converted over to APT yet, let's do that and remove the forrest docs.
>
--
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