fix link issue in readthedocs

aliyun · Jan 17, 2018 · 62c0642 · 62c0642
1 parent 9fb8f9f
commit 62c0642
Show file tree

Hide file tree

Showing 2 changed files with 79 additions and 78 deletions.
diff --git a/README.md b/README.md
@@ -11,42 +11,43 @@
 
 ## Content
 
-* [Introduction](#introduction)
-  * [Brief](#brief)
-  * [Major Features](#major-features)
-* [Installation](#installation)
-  * [Operation System](#operation-system)
-  * [Supported Version](#supported-version)
-  * [Installation Method](#installation-method)
-  * [Full Usage list](#full-usage-list)
-* [Configure CLI](#configure-cli)
-  * [Configure AK and Endpoint](#configure-ak-and-endpoint)
-  * [Modify the configuration file](#modify-the-configuration-file)
-  * [Multiple Account](#multiple-account)
-* [Input and Output](#input-and-output)
-  * [Inputs](#inputs)
-  * [Parameter Validation](#parameter-validation)
-  * [Output](#output)
-  * [Filter output](#filter-output)
-* [Command Reference](#command-reference)
-  * [Command Specification](#command-specification)
-  * [Alias](#alias)
-  * [Subcommand and parameters](#subcommand-and-parameters)
-  * [Global options](#global-options)
-  * [Command categories](#command-categories)
-     * [Project management](#1-project-management)
-     * [Logstore management](#2-logstore-management)
-     * [Shard management](#3-shard-management)
-     * [Machine group management](#4-machine-group-management)
-     * [Logtail config management](#5-logtail-config-management)
-     * [Machine group and Logtail Config Mapping](#6-machine-group-and-logtail-config-mapping)
-     * [Index management](#7-index-management)
-     * [Cursor management](#8-cursor-management)
-     * [Logs write and consume](#9-logs-write-and-consume)
-     * [Shipper management](#10-shipper-management)
-     * [Consumer group management](#11-consumer-group-management)
-  * [Troubleshooting](#troubleshooting)
-* [Other resources](#other-resources)
+   * [User Guide](#user-guide)
+      * [Introduction](#introduction)
+         * [Brief](#brief)
+         * [Major Features](#major-features)
+      * [Installation](#installation)
+         * [Operation System](#operation-system)
+         * [Supported Version](#supported-version)
+         * [Installation Method](#installation-method)
+         * [Full Usage list](#full-usage-list)
+      * [Configure CLI](#configure-cli)
+         * [Configure AK and Endpoint](#configure-ak-and-endpoint)
+         * [Modify the configuration file](#modify-the-configuration-file)
+         * [Multiple Account](#multiple-account)
+      * [Input and Output](#input-and-output)
+         * [Inputs](#inputs)
+         * [Parameter Validation](#parameter-validation)
+         * [Output](#output)
+         * [Filter output](#filter-output)
+      * [Command Reference](#command-reference)
+         * [Command Specification](#command-specification)
+         * [Alias](#alias)
+         * [Subcommand and parameters](#subcommand-and-parameters)
+         * [Global options](#global-options)
+         * [Command categories](#command-categories)
+            * [Project management](#1-project-management)
+            * [Logstore management](#2-logstore-management)
+            * [Shard management](#3-shard-management)
+            * [Machine group management](#4-machine-group-management)
+            * [Logtail config management](#5-logtail-config-management)
+            * [Machine group and Logtail Config Mapping](#6-machine-group-and-logtail-config-mapping)
+            * [Index management](#7-index-management)
+            * [Cursor management](#8-cursor-management)
+            * [Logs write and consume](#9-logs-write-and-consume)
+            * [Shipper management](#10-shipper-management)
+            * [Consumer group management](#11-consumer-group-management)
+            * [Troubleshooting](#troubleshooting)
+      * [Other resources](#other-resources)
 
 
 ## Introduction

diff --git a/README_CN.md b/README_CN.md
@@ -10,44 +10,44 @@
 [README in English](https://github.com/aliyun/aliyun-log-cli/blob/master/README.md)
 
 <h1 id="内容">内容</h1>
-
-* [简介](#简介)
-  * [基本介绍](#基本介绍)
-  * [主要功能](#主要功能)
-* [安装](#安装)
-  * [操作系统](#操作系统)
-  * [支持版本](#支持版本)
-  * [安装方式](#安装方式)
-  * [完整参数列表](#完整参数列表)
-* [配置说明](#配置说明)
-  * [配置AK与服务入口](#配置ak与服务入口)
-  * [修改配置文件](#修改配置文件)
-  * [多账户](#多账户)
-* [输入输出](#输入输出)
-  * [输入](#输入)
-  * [参数校验](#参数校验)
-  * [输出](#输出)
-  * [输出过滤](#输出过滤)
-* [命令参考](#命令参考)
-  * [命令规范](#命令规范)
-     * [命令别名](#命令别名)
-     * [子命令与参数](#子命令与参数)
-     * [全局选项](#全局选项)
-  * [命令类别](#命令类别)
-     * [项目组管理](#1-项目组管理)
-     * [日志库管理](#2-日志库管理)
-     * [分区管理](#3-分区管理)
-     * [机器组管理](#4-机器组管理)
-     * [Logtail配置管理](#5-logtail配置管理)
-     * [机器组与Logtail配置关联](#6-机器组与logtail配置关联)
-     * [索引管理](#7-索引管理)
-     * [游标操作](#8-游标操作)
-     * [日志读写与消费](#9-日志读写与消费)
-     * [投递管理](#10-投递管理)
-     * [消费组管理](#11-消费组管理)
-* [错误诊断](#错误诊断)
-* [其他资源](#其他资源)
-
+* [用户手册](#内容)
+    * [简介](#简介)
+      * [基本介绍](#基本介绍)
+      * [主要功能](#主要功能)
+    * [安装](#安装)
+      * [操作系统](#操作系统)
+      * [支持版本](#支持版本)
+      * [安装方式](#安装方式)
+      * [完整参数列表](#完整参数列表)
+    * [配置说明](#配置说明)
+      * [配置AK与服务入口](#配置ak与服务入口)
+      * [修改配置文件](#修改配置文件)
+      * [多账户](#多账户)
+    * [输入输出](#输入输出)
+      * [输入](#输入)
+      * [参数校验](#参数校验)
+      * [输出](#输出)
+      * [输出过滤](#输出过滤)
+    * [命令参考](#命令参考)
+      * [命令规范](#命令规范)
+         * [命令别名](#命令别名)
+         * [子命令与参数](#子命令与参数)
+         * [全局选项](#全局选项)
+      * [命令类别](#命令类别)
+         * [项目组管理](#1-项目组管理)
+         * [日志库管理](#2-日志库管理)
+         * [分区管理](#3-分区管理)
+         * [机器组管理](#4-机器组管理)
+         * [Logtail配置管理](#5-客户端配置管理)
+         * [机器组与Logtail配置关联](#6-机器组与客户端配置关联)
+         * [索引管理](#7-索引管理)
+         * [游标操作](#8-游标操作)
+         * [日志读写与消费](#9-日志读写与消费)
+         * [投递管理](#10-投递管理)
+         * [消费组管理](#11-消费组管理)
+    * [错误诊断](#错误诊断)
+    * [其他资源](#其他资源)
+    
 
 <h1 id="简介">简介</h1>
 
@@ -339,8 +339,8 @@ def create_logstore(self, project_name, logstore_name, ttl=2, shard_count=30):
  2. [日志库管理](#2-日志库管理)
  3. [分区管理](#3-分区管理)
  4. [机器组管理](#4-机器组管理)
- 5. [Logtail配置管理](#5-logtail配置管理)
- 6. [机器组与Logtail配置关联](#6-机器组与logtail配置关联)
+ 5. [Logtail配置管理](#5-客户端配置管理)
+ 6. [机器组与Logtail配置关联](#6-机器组与客户端配置关联)
  7. [索引管理](#7-索引管理)
  8. [游标操作](#8-游标操作)
  9. [日志读写与消费](#9-日志读写与消费)
@@ -407,7 +407,7 @@ def create_logstore(self, project_name, logstore_name, ttl=2, shard_count=30):
 - list_machine_group
 - list_machines
 
-<h3 id="5-Logtail配置管理">5. Logtail配置管理</h3>
+<h3 id="5-客户端配置管理">5. Logtail配置管理</h3>
 
 - create_logtail_config
    - 参考[创建Logtail配置](./tutorials/tutorial_create_logtail_config.html)了解如何创建各种格式的Logtail配置.
@@ -417,7 +417,7 @@ def create_logstore(self, project_name, logstore_name, ttl=2, shard_count=30):
 - list_logtail_config
 
 
-<h3 id="6-机器组与Logtail配置关联">6. 机器组与Logtail配置关联</h3>
+<h3 id="6-机器组与客户端配置关联">6. 机器组与Logtail配置关联</h3>
 
 - apply_config_to_machine_group
 - remove_config_to_machine_group