From 8faca274772b87138c45f5aa66d432c17b7c0e98 Mon Sep 17 00:00:00 2001 From: "zhu.boxiang" Date: Thu, 9 Sep 2021 11:10:57 +0800 Subject: [PATCH] docs: Update README doc to link devstack README doc 1. Add devstack README doc link to README zh_CN and en doc 2. Update the table of contents Change-Id: Iff2dae1d87e6f01eb564542e4b3718f9cfba0887 --- README-zh_CN.md | 19 ++++++++++++++++--- README.md | 19 ++++++++++++++++--- 2 files changed, 32 insertions(+), 6 deletions(-) diff --git a/README-zh_CN.md b/README-zh_CN.md index e71732c..51100a3 100644 --- a/README-zh_CN.md +++ b/README-zh_CN.md @@ -10,9 +10,18 @@ Skyline 的吉祥物是九色鹿。九色鹿源自于敦煌壁画《九色鹿本 **目录** -- [资源](#资源) -- [快速开始](#快速开始) -- [开发 Skyline-apiserver](#开发-skyline-apiserver) +- [Skyline](#skyline) + - [资源](#资源) + - [快速开始](#快速开始) + - [先决条件](#先决条件) + - [配置](#配置) + - [部署 - 数据库使用 Sqlite](#部署---数据库使用-sqlite) + - [部署 - 数据库使用 MariaDB](#部署---数据库使用-mariadb) + - [访问测试](#访问测试) + - [开发 Skyline-apiserver](#开发-skyline-apiserver) + - [依赖工具](#依赖工具) + - [安装和运行](#安装和运行) + - [Devstack 集成](#devstack-集成) ## 资源 @@ -205,3 +214,7 @@ Skyline 的吉祥物是九色鹿。九色鹿源自于敦煌壁画《九色鹿本 ```bash make build ``` + +## Devstack 集成 + +[与 Devstack 快速集成,搭建环境。](./devstack/README.rst) diff --git a/README.md b/README.md index 39a8fd7..94d27b2 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,18 @@ Skyline's mascot is the nine-color deer. The nine-color deer comes from Dunhuang **Table of contents** -- [Resources](#resources) -- [Quick Start](#quick-start) -- [Develop Skyline-apiserver](#develop-skyline-apiserver) +- [Skyline API](#skyline-api) + - [Resources](#resources) + - [Quick Start](#quick-start) + - [Prerequisites](#prerequisites) + - [Configure](#configure) + - [Deployment with Sqlite](#deployment-with-sqlite) + - [Deployment with MariaDB](#deployment-with-mariadb) + - [Test Access](#test-access) + - [Develop Skyline-apiserver](#develop-skyline-apiserver) + - [Dependent tools](#dependent-tools) + - [Install & Run](#install--run) + - [Devstack Integration](#devstack-integration) ## Resources @@ -205,3 +214,7 @@ You can now access the dashboard: `https://:8080` ```bash make build ``` + +## Devstack Integration + +[Fast integration with Devstack to build an environment.](./devstack/README.rst)