From 8c0247f99b88027f100bd610287eef31c2a1a3e5 Mon Sep 17 00:00:00 2001
From: "zhu.boxiang" <zhu.boxiang@99cloud.net>
Date: Wed, 12 Jan 2022 18:15:20 +0800
Subject: [PATCH] docs: Update README doc file

Update README doc file.

Change-Id: I3f19dc907bd9fc158f73d34af4725400a9388d06
---
 .zuul.yaml      |  8 ++++++++
 README-zh_CN.md | 18 +++++++++++++++++-
 README.md       | 16 ++++++++++++++++
 3 files changed, 41 insertions(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index a440cbb7..2ad2f4b5 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -566,6 +566,8 @@
               - ^src/asset/.*$
               # .zuul.yaml
               - ^.zuul.yaml$
+              # markdown
+              - ^.*\.md$
         - skyline-console-devstack-e2etests-network:
             irrelevant-files: &e2etests-network-irrelevant-files
               # compute
@@ -595,6 +597,8 @@
               - ^src/asset/.*$
               # .zuul.yaml
               - ^.zuul.yaml$
+              # markdown
+              - ^.*\.md$
         - skyline-console-devstack-e2etests-other:
             irrelevant-files: &e2etests-other-irrelevant-files
               # compute
@@ -617,6 +621,8 @@
               - ^src/asset/.*$
               # .zuul.yaml
               - ^.zuul.yaml$
+              # markdown
+              - ^.*\.md$
         - skyline-console-devstack-e2etests-storage:
             irrelevant-files: &e2etests-storage-irrelevant-files
               # compute
@@ -647,6 +653,8 @@
               - ^src/asset/.*$
               # .zuul.yaml
               - ^.zuul.yaml$
+              # markdown
+              - ^.*\.md$
     gate:
       jobs:
         - skyline-nodejs14-run-lint-src
diff --git a/README-zh_CN.md b/README-zh_CN.md
index 7f1b18b3..17312b86 100644
--- a/README-zh_CN.md
+++ b/README-zh_CN.md
@@ -2,6 +2,22 @@
 
 简体中文 | [English](./README.md)
 
+**目录**
+
+- [使用说明](#使用说明)
+  - [资源](#资源)
+  - [环境依赖](#环境依赖)
+  - [本地环境搭建](#本地环境搭建)
+  - [开发使用方法](#开发使用方法)
+  - [文档](#文档)
+    - [如何开发](#如何开发)
+    - [如何测试](#如何测试)
+
+## 资源
+
+- [Wiki](https://wiki.openstack.org/wiki/Skyline)
+- [Bug 跟踪器](https://launchpad.net/skyline-apiserver)
+
 ## 环境依赖
 
 - `node`: lts/erbium (v12.\*)
@@ -84,7 +100,7 @@
 - [Route 介绍](docs/zh/develop/3-13-Route-introduction.md)
 - [I18n 介绍](docs/zh/develop/3-14-I18n-introduction.md)
 
-### How to test
+### 如何测试
 
 - [两种不同的测试方式](docs/zh/test/1-ready-to-work.md)
 - [目录结构](docs/zh/test/2-catalog-introduction.md)
diff --git a/README.md b/README.md
index 981170ec..a3a0cbe6 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,22 @@
 
 [简体中文](./README-zh_CN.md)| English
 
+**Table of contents**
+
+- [Instructions](#instructions)
+  - [Resources](#resources)
+  - [Prerequisites](#prerequisites)
+  - [Local Environment](#local-environment)
+  - [Usage](#usage)
+  - [Docs](#docs)
+    - [How to develop](#how-to-develop)
+    - [How to test](#how-to-test)
+
+## Resources
+
+- [Wiki](https://wiki.openstack.org/wiki/Skyline)
+- [Bug Tracker](https://launchpad.net/skyline-apiserver)
+
 ## Prerequisites
 
 - `node`: lts/erbium (v12.\*)