Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major 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

      1. hadoop-doc-menu-2.doc
        98 kB
        Corinne Chandel
      2. hadoop-menu-titles-edits-5.patch
        20 kB
        Corinne Chandel
      3. 5468_20090320.jpg
        197 kB
        Tsz Wo Nicholas Sze
      4. menu-titles-6.patch
        19 kB
        Corinne Chandel

        Activity

        Corinne Chandel created issue -
        Hide
        Corinne Chandel added a comment -

        (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

        Show
        Corinne Chandel added a comment - (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
        Corinne Chandel made changes -
        Field Original Value New Value
        Attachment Hadoop-menu-titles.patch [ 12401998 ]
        Attachment Hadoop-Doc-Menu.doc [ 12401999 ]
        Hide
        Corinne Chandel added a comment -

        No new test code; changes to documentation only.

        Show
        Corinne Chandel added a comment - No new test code; changes to documentation only.
        Hide
        Tsz Wo Nicholas Sze added a comment -

        +1 patch looks good.

        Show
        Tsz Wo Nicholas Sze added a comment - +1 patch looks good.
        Tsz Wo Nicholas Sze made changes -
        Hadoop Flags [Reviewed]
        Assignee Corinne Chandel [ chandec ]
        Component/s documentation [ 12311160 ]
        Hide
        Tsz Wo Nicholas Sze added a comment -

        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
        
        Show
        Tsz Wo Nicholas Sze added a comment - 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
        Hide
        Corinne Chandel added a comment -

        Patch #2 for menu and titles.

        Show
        Corinne Chandel added a comment - Patch #2 for menu and titles.
        Corinne Chandel made changes -
        Attachment hadoop-menu-titles-2.patch [ 12402093 ]
        Corinne Chandel made changes -
        Status Open [ 1 ] Patch Available [ 10002 ]
        Hide
        Hadoop QA added a comment -

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

        Show
        Hadoop QA added a comment - -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.
        Corinne Chandel made changes -
        Attachment hadoop-menu-titles-3.patch [ 12402107 ]
        Corinne Chandel made changes -
        Attachment menu-titles-edits-4.patch [ 12402428 ]
        Hide
        Corinne Chandel added a comment - - edited

        Screen shot #2 of Hadoop doc menu (for patch #5).

        Show
        Corinne Chandel added a comment - - edited Screen shot #2 of Hadoop doc menu (for patch #5).
        Corinne Chandel made changes -
        Attachment hadoop-doc-menu-2.doc [ 12402431 ]
        Hide
        Corinne Chandel added a comment -

        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

        Show
        Corinne Chandel added a comment - 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
        Corinne Chandel made changes -
        Attachment hadoop-menu-titles-edits-5.patch [ 12402511 ]
        Corinne Chandel made changes -
        Attachment menu-titles-edits-4.patch [ 12402428 ]
        Corinne Chandel made changes -
        Attachment hadoop-menu-titles-3.patch [ 12402107 ]
        Corinne Chandel made changes -
        Attachment hadoop-menu-titles-2.patch [ 12402093 ]
        Corinne Chandel made changes -
        Attachment Hadoop-menu-titles.patch [ 12401998 ]
        Corinne Chandel made changes -
        Attachment Hadoop-Doc-Menu.doc [ 12401999 ]
        Corinne Chandel made changes -
        Comment [ Patch #4 - menu-titles-edits-4.patch

        Reorganized menu items based on feedback from last week.
        Changed doc files to match menu as needed.
        Made minor edits to some files.
        Included fixed for Bugzilla ticket 2409052 (hdfs_shell.xml).

        See if this goes through ... docs build OK on my machine.

        Note: No new test code; changes to documentation only. ]
        Corinne Chandel made changes -
        Comment [ Patch #3

        Removed libhdfs.xml from the path (title close enough to menu).

        Note: No new test code; changes to documentation only. ]
        Hide
        Tsz Wo Nicholas Sze added a comment -

        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.

        Show
        Tsz Wo Nicholas Sze added a comment - 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.
        Hide
        Tsz Wo Nicholas Sze added a comment -

        5468_20090320.jpg: this is the generated doc screen shot.

        Show
        Tsz Wo Nicholas Sze added a comment - 5468_20090320.jpg: this is the generated doc screen shot.
        Tsz Wo Nicholas Sze made changes -
        Attachment 5468_20090320.jpg [ 12402684 ]
        Hide
        Corinne Chandel added a comment -

        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

        Show
        Corinne Chandel added a comment - 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
        Corinne Chandel made changes -
        Attachment menu-titles-6.patch [ 12402689 ]
        Hide
        Tsz Wo Nicholas Sze added a comment -

        I committed this to 0.20 and above. Thanks, Corinne!

        Show
        Tsz Wo Nicholas Sze added a comment - I committed this to 0.20 and above. Thanks, Corinne!
        Tsz Wo Nicholas Sze made changes -
        Status Patch Available [ 10002 ] Resolved [ 5 ]
        Fix Version/s 0.20.0 [ 12313438 ]
        Fix Version/s 0.21.0 [ 12313563 ]
        Resolution Fixed [ 1 ]
        Hide
        Hudson added a comment -

        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)

        Show
        Hudson added a comment - 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)
        Robert Chansler made changes -
        Release Note Reformatted HTML documentation for Hadoop to use submenus at the left column.
        Nigel Daley made changes -
        Fix Version/s 0.21.0 [ 12313563 ]
        Nigel Daley made changes -
        Status Resolved [ 5 ] Closed [ 6 ]

          People

          • Assignee:
            Corinne Chandel
            Reporter:
            Corinne Chandel
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development