Browse Source

MAPREDUCE-6644. Use doxia macro to generate in-page TOC of MapReduce site documentation. (iwasakims)

(cherry picked from commit 3619ae32bea227f17ecc9ef964e9194bc09fac0b)
Masatake Iwasaki 8 years ago
parent
commit
2f4cf07fb1

+ 2 - 0
hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/site/markdown/DistributedCacheDeploy.md.vm

@@ -19,6 +19,8 @@
 Hadoop: Distributed Cache Deploy
 ================================
 
+<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
+
 Introduction
 ------------
 

+ 2 - 0
hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/site/markdown/EncryptedShuffle.md

@@ -15,6 +15,8 @@
 Hadoop: Encrypted Shuffle
 =========================
 
+<!-- MACRO{toc|fromDepth=0|toDepth=2} -->
+
 Introduction
 ------------
 

+ 1 - 44
hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/site/markdown/MapReduceTutorial.md

@@ -15,50 +15,7 @@
 MapReduce Tutorial
 ==================
 
-* [MapReduce Tutorial](#MapReduce_Tutorial)
-    * [Purpose](#Purpose)
-    * [Prerequisites](#Prerequisites)
-    * [Overview](#Overview)
-    * [Inputs and Outputs](#Inputs_and_Outputs)
-    * [Example: WordCount v1.0](#Example:_WordCount_v1.0)
-        * [Source Code](#Source_Code)
-        * [Usage](#Usage)
-        * [Walk-through](#Walk-through)
-    * [MapReduce - User Interfaces](#MapReduce_-_User_Interfaces)
-        * [Payload](#Payload)
-            * [Mapper](#Mapper)
-            * [Reducer](#Reducer)
-            * [Partitioner](#Partitioner)
-            * [Counter](#Counter)
-        * [Job Configuration](#Job_Configuration)
-        * [Task Execution & Environment](#Task_Execution__Environment)
-            * [Memory Management](#Memory_Management)
-            * [Map Parameters](#Map_Parameters)
-            * [Shuffle/Reduce Parameters](#ShuffleReduce_Parameters)
-            * [Configured Parameters](#Configured_Parameters)
-            * [Task Logs](#Task_Logs)
-            * [Distributing Libraries](#Distributing_Libraries)
-        * [Job Submission and Monitoring](#Job_Submission_and_Monitoring)
-            * [Job Control](#Job_Control)
-        * [Job Input](#Job_Input)
-            * [InputSplit](#InputSplit)
-            * [RecordReader](#RecordReader)
-        * [Job Output](#Job_Output)
-            * [OutputCommitter](#OutputCommitter)
-            * [Task Side-Effect Files](#Task_Side-Effect_Files)
-            * [RecordWriter](#RecordWriter)
-        * [Other Useful Features](#Other_Useful_Features)
-            * [Submitting Jobs to Queues](#Submitting_Jobs_to_Queues)
-            * [Counters](#Counters)
-            * [DistributedCache](#DistributedCache)
-            * [Profiling](#Profiling)
-            * [Debugging](#Debugging)
-            * [Data Compression](#Data_Compression)
-            * [Skipping Bad Records](#Skipping_Bad_Records)
-        * [Example: WordCount v2.0](#Example:_WordCount_v2.0)
-            * [Source Code](#Source_Code)
-            * [Sample Runs](#Sample_Runs)
-            * [Highlights](#Highlights)
+<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
 
 Purpose
 -------

+ 2 - 0
hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/site/markdown/MapReduce_Compatibility_Hadoop1_Hadoop2.md

@@ -15,6 +15,8 @@
 Apache Hadoop MapReduce - Migrating from Apache Hadoop 1.x to Apache Hadoop 2.x
 ===============================================================================
 
+<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
+
 Introduction
 ------------
 

+ 1 - 15
hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/site/markdown/MapredAppMasterRest.md

@@ -15,21 +15,7 @@
 MapReduce Application Master REST API's.
 ========================================
 
-* [MapReduce Application Master REST API's.](#MapReduce_Application_Master_REST_APIs.)
-    * [Overview](#Overview)
-    * [Mapreduce Application Master Info API](#Mapreduce_Application_Master_Info_API)
-    * [Jobs API](#Jobs_API)
-    * [Job API](#Job_API)
-    * [Job Attempts API](#Job_Attempts_API)
-    * [Job Counters API](#Job_Counters_API)
-    * [Job Conf API](#Job_Conf_API)
-    * [Tasks API](#Tasks_API)
-    * [Task API](#Task_API)
-    * [Task Counters API](#Task_Counters_API)
-    * [Task Attempts API](#Task_Attempts_API)
-    * [Task Attempt API](#Task_Attempt_API)
-    * [Task Attempt State API](#Task_Attempt_State_API)
-    * [Task Attempt Counters API](#Task_Attempt_Counters_API)
+<!-- MACRO{toc|fromDepth=0|toDepth=1} -->
 
 Overview
 --------

+ 1 - 13
hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/site/markdown/MapredCommands.md

@@ -15,19 +15,7 @@
 MapReduce Commands Guide
 ========================
 
-* [Overview](#Overview)
-* [User Commands](#User_Commands)
-    * [archive](#archive)
-    * [archive-logs](#archive-logs)
-    * [classpath](#classpath)
-    * [distcp](#distcp)
-    * [job](#job)
-    * [pipes](#pipes)
-    * [queue](#queue)
-    * [version](#version)
-* [Administration Commands](#Administration_Commands)
-    * [historyserver](#historyserver)
-    * [hsadmin](#hsadmin)
+<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
 
 Overview
 --------

+ 2 - 0
hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/site/markdown/PluggableShuffleAndPluggableSort.md

@@ -15,6 +15,8 @@
 Hadoop: Pluggable Shuffle and Pluggable Sort
 ============================================
 
+<!-- MACRO{toc|fromDepth=0|toDepth=3} -->
+
 Introduction
 ------------
 

+ 1 - 21
hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-hs/src/site/markdown/HistoryServerRest.md

@@ -15,27 +15,7 @@
 MapReduce History Server REST API's.
 ====================================
 
-* [MapReduce History Server REST API's.](#MapReduce_History_Server_REST_APIs.)
-    * [Overview](#Overview)
-    * [History Server Information API](#History_Server_Information_API)
-        * [URI](#URI)
-        * [HTTP Operations Supported](#HTTP_Operations_Supported)
-        * [Query Parameters Supported](#Query_Parameters_Supported)
-        * [Elements of the historyInfo object](#Elements_of_the_historyInfo_object)
-        * [Response Examples](#Response_Examples)
-    * [MapReduce API's](#MapReduce_APIs)
-        * [Jobs API](#Jobs_API)
-        * [Job API](#Job_API)
-        * [Elements of the acls object](#Elements_of_the_acls_object)
-        * [Job Attempts API](#Job_Attempts_API)
-        * [Job Counters API](#Job_Counters_API)
-        * [Job Conf API](#Job_Conf_API)
-        * [Tasks API](#Tasks_API)
-        * [Task API](#Task_API)
-        * [Task Counters API](#Task_Counters_API)
-        * [Task Attempts API](#Task_Attempts_API)
-        * [Task Attempt API](#Task_Attempt_API)
-        * [Task Attempt Counters API](#Task_Attempt_Counters_API)
+<!-- MACRO{toc|fromDepth=0|toDepth=2} -->
 
 Overview
 --------