Uploaded image for project: 'Hadoop Common'
  1. Hadoop Common
  2. HADOOP-11594

Improve the readability of site index of documentation

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.8.0, 3.0.0-alpha1
    • Component/s: documentation
    • Labels:
      None

      Description

      • change the order of items
      • make redundant title shorter and fit it in single line as far as possible
      1. HADOOP-11594.004.patch
        8 kB
        Masatake Iwasaki
      2. HADOOP-11594.003.patch
        12 kB
        Masatake Iwasaki
      3. HADOOP-11594.002.patch
        12 kB
        Masatake Iwasaki
      4. HADOOP-11594.001.patch
        12 kB
        Masatake Iwasaki

        Activity

        Hide
        iwasakims Masatake Iwasaki added a comment -

        I attached 001. The new order is "read this first" at first then alphabetical.

        Show
        iwasakims Masatake Iwasaki added a comment - I attached 001. The new order is "read this first" at first then alphabetical.
        Hide
        hadoopqa Hadoop QA added a comment -

        +1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12698791/HADOOP-11594.001.patch
        against trunk revision 72389c7.

        +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 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 javadoc. There were no new javadoc warning messages.

        +1 eclipse:eclipse. The patch built with eclipse:eclipse.

        +1 findbugs. The patch does not introduce any new Findbugs (version 2.0.3) warnings.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        +1 core tests. The patch passed unit tests in .

        Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/5728//testReport/
        Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/5728//console

        This message is automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - +1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12698791/HADOOP-11594.001.patch against trunk revision 72389c7. +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 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . There were no new javadoc warning messages. +1 eclipse:eclipse . The patch built with eclipse:eclipse. +1 findbugs . The patch does not introduce any new Findbugs (version 2.0.3) warnings. +1 release audit . The applied patch does not increase the total number of release audit warnings. +1 core tests . The patch passed unit tests in . Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/5728//testReport/ Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/5728//console This message is automatically generated.
        Hide
        aw Allen Wittenauer added a comment -

        Some comments:

        • I think Secure Mode should be higher, definitely above the compatibility and interface parts.
        • I'm inclined to think that fs shell and commands reference should be in common, not general. They probably should have been moved in the 1.x to 2.x transition.
        • I'm not a fan of the AuthN and AuthZ change, mainly because there are lots of other places where AuthZ-type control is being done.
        Show
        aw Allen Wittenauer added a comment - Some comments: I think Secure Mode should be higher, definitely above the compatibility and interface parts. I'm inclined to think that fs shell and commands reference should be in common, not general. They probably should have been moved in the 1.x to 2.x transition. I'm not a fan of the AuthN and AuthZ change, mainly because there are lots of other places where AuthZ-type control is being done.
        Hide
        iwasakims Masatake Iwasaki added a comment -

        Thanks, Allen Wittenauer. I agree with your comments. I update the patch. In addition to above, I replaced "Heterogeneous Storage" by "Storage Policy".

        Show
        iwasakims Masatake Iwasaki added a comment - Thanks, Allen Wittenauer . I agree with your comments. I update the patch. In addition to above, I replaced "Heterogeneous Storage" by "Storage Policy".
        Hide
        hadoopqa Hadoop QA added a comment -

        +1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12700614/HADOOP-11594.002.patch
        against trunk revision ac3468a.

        +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 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 javadoc. There were no new javadoc warning messages.

        +1 eclipse:eclipse. The patch built with eclipse:eclipse.

        +1 findbugs. The patch does not introduce any new Findbugs (version 2.0.3) warnings.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        +1 core tests. The patch passed unit tests in .

        Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/5772//testReport/
        Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/5772//console

        This message is automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - +1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12700614/HADOOP-11594.002.patch against trunk revision ac3468a. +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 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . There were no new javadoc warning messages. +1 eclipse:eclipse . The patch built with eclipse:eclipse. +1 findbugs . The patch does not introduce any new Findbugs (version 2.0.3) warnings. +1 release audit . The applied patch does not increase the total number of release audit warnings. +1 core tests . The patch passed unit tests in . Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/5772//testReport/ Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/5772//console This message is automatically generated.
        Hide
        iwasakims Masatake Iwasaki added a comment -

        I attached rebased patch.

        Show
        iwasakims Masatake Iwasaki added a comment - I attached rebased patch.
        Hide
        hadoopqa Hadoop QA added a comment -



        +1 overall



        Vote Subsystem Runtime Comment
        0 pre-patch 2m 52s Pre-patch trunk compilation is healthy.
        +1 @author 0m 0s The patch does not contain any @author tags.
        +1 whitespace 0m 0s The patch has no lines that end in whitespace.
        +1 release audit 0m 20s The applied patch does not increase the total number of release audit warnings.
        +1 site 2m 53s Site still builds.
            6m 9s  



        Subsystem Report/Notes
        Patch URL http://issues.apache.org/jira/secure/attachment/12729057/HADOOP-11594.003.patch
        Optional Tests site
        git revision trunk / 8f82970
        Java 1.7.0_55
        uname Linux asf900.gq1.ygridcore.net 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux
        Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/6211/console

        This message was automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - +1 overall Vote Subsystem Runtime Comment 0 pre-patch 2m 52s Pre-patch trunk compilation is healthy. +1 @author 0m 0s The patch does not contain any @author tags. +1 whitespace 0m 0s The patch has no lines that end in whitespace. +1 release audit 0m 20s The applied patch does not increase the total number of release audit warnings. +1 site 2m 53s Site still builds.     6m 9s   Subsystem Report/Notes Patch URL http://issues.apache.org/jira/secure/attachment/12729057/HADOOP-11594.003.patch Optional Tests site git revision trunk / 8f82970 Java 1.7.0_55 uname Linux asf900.gq1.ygridcore.net 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/6211/console This message was automatically generated.
        Hide
        iwasakims Masatake Iwasaki added a comment -

        I rethinked about this. Changing titles and order of items at the same is hard to review and confusing to readers. Attached 004 just makes redundant titles shorter while keeping order of items except for "Architecture" of HDFS and "Commands Reference" of YARN.

        Show
        iwasakims Masatake Iwasaki added a comment - I rethinked about this. Changing titles and order of items at the same is hard to review and confusing to readers. Attached 004 just makes redundant titles shorter while keeping order of items except for "Architecture" of HDFS and "Commands Reference" of YARN.
        Hide
        hadoopqa Hadoop QA added a comment -



        -1 overall



        Vote Subsystem Runtime Comment
        0 pre-patch 2m 54s Pre-patch trunk compilation is healthy.
        +1 @author 0m 0s The patch does not contain any @author tags.
        +1 release audit 0m 19s The applied patch does not increase the total number of release audit warnings.
        +1 site 2m 57s Site still builds.
        -1 whitespace 0m 0s The patch has 1 line(s) that end in whitespace. Use git apply --whitespace=fix.
            6m 13s  



        Subsystem Report/Notes
        Patch URL http://issues.apache.org/jira/secure/attachment/12734087/HADOOP-11594.004.patch
        Optional Tests site
        git revision trunk / ce53c8e
        whitespace https://builds.apache.org/job/PreCommit-HADOOP-Build/6784/artifact/patchprocess/whitespace.txt
        Java 1.7.0_55
        uname Linux asf901.gq1.ygridcore.net 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux
        Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/6784/console

        This message was automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - -1 overall Vote Subsystem Runtime Comment 0 pre-patch 2m 54s Pre-patch trunk compilation is healthy. +1 @author 0m 0s The patch does not contain any @author tags. +1 release audit 0m 19s The applied patch does not increase the total number of release audit warnings. +1 site 2m 57s Site still builds. -1 whitespace 0m 0s The patch has 1 line(s) that end in whitespace. Use git apply --whitespace=fix.     6m 13s   Subsystem Report/Notes Patch URL http://issues.apache.org/jira/secure/attachment/12734087/HADOOP-11594.004.patch Optional Tests site git revision trunk / ce53c8e whitespace https://builds.apache.org/job/PreCommit-HADOOP-Build/6784/artifact/patchprocess/whitespace.txt Java 1.7.0_55 uname Linux asf901.gq1.ygridcore.net 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/6784/console This message was automatically generated.
        Hide
        ajisakaa Akira Ajisaka added a comment -

        +1, built the document and the index looks good to me.

        Show
        ajisakaa Akira Ajisaka added a comment - +1, built the document and the index looks good to me.
        Hide
        ajisakaa Akira Ajisaka added a comment -

        Found a dead link when reviewing the patch. Filed YARN-3694.

        Show
        ajisakaa Akira Ajisaka added a comment - Found a dead link when reviewing the patch. Filed YARN-3694 .
        Hide
        ajisakaa Akira Ajisaka added a comment -

        Committed this to trunk and branch-2. Thanks Masatake Iwasaki for contribution.

        Show
        ajisakaa Akira Ajisaka added a comment - Committed this to trunk and branch-2. Thanks Masatake Iwasaki for contribution.
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Hadoop-trunk-Commit #7891 (See https://builds.apache.org/job/Hadoop-trunk-Commit/7891/)
        HADOOP-11594. Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565)

        • hadoop-common-project/hadoop-common/CHANGES.txt
        • hadoop-project/src/site/site.xml
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Hadoop-trunk-Commit #7891 (See https://builds.apache.org/job/Hadoop-trunk-Commit/7891/ ) HADOOP-11594 . Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565) hadoop-common-project/hadoop-common/CHANGES.txt hadoop-project/src/site/site.xml
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Hadoop-Yarn-trunk #935 (See https://builds.apache.org/job/Hadoop-Yarn-trunk/935/)
        HADOOP-11594. Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565)

        • hadoop-common-project/hadoop-common/CHANGES.txt
        • hadoop-project/src/site/site.xml
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Hadoop-Yarn-trunk #935 (See https://builds.apache.org/job/Hadoop-Yarn-trunk/935/ ) HADOOP-11594 . Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565) hadoop-common-project/hadoop-common/CHANGES.txt hadoop-project/src/site/site.xml
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Hadoop-Yarn-trunk-Java8 #204 (See https://builds.apache.org/job/Hadoop-Yarn-trunk-Java8/204/)
        HADOOP-11594. Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565)

        • hadoop-common-project/hadoop-common/CHANGES.txt
        • hadoop-project/src/site/site.xml
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Hadoop-Yarn-trunk-Java8 #204 (See https://builds.apache.org/job/Hadoop-Yarn-trunk-Java8/204/ ) HADOOP-11594 . Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565) hadoop-common-project/hadoop-common/CHANGES.txt hadoop-project/src/site/site.xml
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Hadoop-Hdfs-trunk #2133 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/2133/)
        HADOOP-11594. Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565)

        • hadoop-project/src/site/site.xml
        • hadoop-common-project/hadoop-common/CHANGES.txt
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Hdfs-trunk #2133 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/2133/ ) HADOOP-11594 . Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565) hadoop-project/src/site/site.xml hadoop-common-project/hadoop-common/CHANGES.txt
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Hadoop-Hdfs-trunk-Java8 #193 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk-Java8/193/)
        HADOOP-11594. Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565)

        • hadoop-common-project/hadoop-common/CHANGES.txt
        • hadoop-project/src/site/site.xml
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Hdfs-trunk-Java8 #193 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk-Java8/193/ ) HADOOP-11594 . Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565) hadoop-common-project/hadoop-common/CHANGES.txt hadoop-project/src/site/site.xml
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Hadoop-Mapreduce-trunk-Java8 #203 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Java8/203/)
        HADOOP-11594. Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565)

        • hadoop-project/src/site/site.xml
        • hadoop-common-project/hadoop-common/CHANGES.txt
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Hadoop-Mapreduce-trunk-Java8 #203 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Java8/203/ ) HADOOP-11594 . Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565) hadoop-project/src/site/site.xml hadoop-common-project/hadoop-common/CHANGES.txt
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Hadoop-Mapreduce-trunk #2151 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/2151/)
        HADOOP-11594. Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565)

        • hadoop-common-project/hadoop-common/CHANGES.txt
        • hadoop-project/src/site/site.xml
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Hadoop-Mapreduce-trunk #2151 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/2151/ ) HADOOP-11594 . Improve the readability of site index of documentation. Contributed by Masatake Iwasaki. (aajisaka: rev ab7958f22774ac2a8d1dad322453ff1db16a1565) hadoop-common-project/hadoop-common/CHANGES.txt hadoop-project/src/site/site.xml

          People

          • Assignee:
            iwasakims Masatake Iwasaki
            Reporter:
            iwasakims Masatake Iwasaki
          • Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development