Details
-
Type:
Improvement
-
Status: Closed
-
Priority:
Major
-
Resolution: Fixed
-
Affects Version/s: None
-
Fix Version/s: 0.20.0
-
Component/s: documentation
-
Labels:None
-
Hadoop Flags:Reviewed
-
Release Note:Reformatted HTML documentation for Hadoop to use submenus at the left column.
Description
In directory Trunk\src\docs\src\documentation\content\xdocs ...
1. site.xml - changed doc menu to submenus
2. *.xml - for a few docs, changed titles to match submenus and made some minor edits
Activity
No new test code; changes to documentation only.
+1 patch looks good.
however, the patch cannot be applied. Could you check it, Corinne?
patching file src/docs/src/documentation/content/xdocs/libhdfs.xml Hunk #1 FAILED at 22. Hunk #2 FAILED at 47. Hunk #3 FAILED at 74. 3 out of 3 hunks FAILED -- saving rejects to file src/docs/src/documentation/content/xdocs/libhdfs.xml.rej
Patch #2 for menu and titles.
-1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12402093/hadoop-menu-titles-2.patch
against trunk revision 753052.
+1 @author. The patch does not contain any @author tags.
+0 tests included. The patch appears to be a documentation patch that doesn't require tests.
-1 patch. The patch command could not apply the patch.
Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/79/console
This message is automatically generated.
Screen shot #2 of Hadoop doc menu (for patch #5).
Patch #5 - menu-titles-edits-5.patch
Reorganized menu items based on feedback from last week.
Changed doc files to match menu as needed.
Made minor edits to some files.
See if this goes through ... docs build OK on my machine.
Note: No new test code; changes to documentation only
Checked hadoop-menu-titles-edits-5.patch. I still have problems on applying streaming.xml and libhdfs.xml. Let's just remove the changes of these two files here and fix them later.
In hod.xml, if the file is no longer in use, we should remove it.
5468_20090320.jpg: this is the generated doc screen shot.
Patch #6 - menu-titles-6.patch
Created using Cygwin
> streaming.xml - not changed (problem when included w/ patch)
> libhdfs.xml - not changed (problem when included w/ patch)
> hod.xml - turned into empty file (no longer in use)
Note: No new test code; changes to documentation only
I committed this to 0.20 and above. Thanks, Corinne!
Integrated in Hadoop-trunk #786 (See http://hudson.zones.apache.org/hudson/job/Hadoop-trunk/786/)
. Add sub-menus to forrest documentation and make some minor edits. (Corinne Chandel via szetszwo)
(1) Hadoop-menu-titles.patch - changes for site.xml (menu to submenu) and *.xml (doc titles and minor edits)
(2) Hadoop-Doc-Menu.doc - screen shot of what new submenus look like