docs: Change md file to rst file
1. change md file to rst file for readme 2. add README.rst to description_file in setup.cfg Change-Id: I713a39cd99f54d5474fb263d65d70cf9195e15cb
This commit is contained in:
Boxiang Zhu
parent
6c746303c6
commit
d3251bd329
|
|
@ -589,6 +589,8 @@
|
|||
- ^.zuul.yaml$
|
||||
# markdown
|
||||
- ^.*\.md$
|
||||
# rst
|
||||
- ^.*\.rst$
|
||||
# releasenotes
|
||||
- ^releasenotes/.*$
|
||||
- skyline-console-devstack-e2etests-network:
|
||||
|
|
@ -638,6 +640,8 @@
|
|||
- ^.zuul.yaml$
|
||||
# markdown
|
||||
- ^.*\.md$
|
||||
# rst
|
||||
- ^.*\.rst$
|
||||
# releasenotes
|
||||
- ^releasenotes/.*$
|
||||
- skyline-console-devstack-e2etests-other:
|
||||
|
|
@ -673,6 +677,8 @@
|
|||
- ^.zuul.yaml$
|
||||
# markdown
|
||||
- ^.*\.md$
|
||||
# rst
|
||||
- ^.*\.rst$
|
||||
# releasenotes
|
||||
- ^releasenotes/.*$
|
||||
- skyline-console-devstack-e2etests-storage:
|
||||
|
|
@ -724,6 +730,8 @@
|
|||
- ^.zuul.yaml$
|
||||
# markdown
|
||||
- ^.*\.md$
|
||||
# rst
|
||||
- ^.*\.rst$
|
||||
# releasenotes
|
||||
- ^releasenotes/.*$
|
||||
gate:
|
||||
|
|
|
|||
111
README-zh_CN.md
111
README-zh_CN.md
|
|
@ -1,111 +0,0 @@
|
|||
# 使用说明
|
||||
|
||||
简体中文 | [English](./README.md)
|
||||
|
||||
**目录**
|
||||
|
||||
- [使用说明](#使用说明)
|
||||
- [资源](#资源)
|
||||
- [环境依赖](#环境依赖)
|
||||
- [本地环境搭建](#本地环境搭建)
|
||||
- [开发使用方法](#开发使用方法)
|
||||
- [文档](#文档)
|
||||
- [如何开发](#如何开发)
|
||||
- [如何测试](#如何测试)
|
||||
|
||||
## 资源
|
||||
|
||||
- [Wiki](https://wiki.openstack.org/wiki/Skyline)
|
||||
- [Bug 跟踪器](https://launchpad.net/skyline-apiserver)
|
||||
|
||||
## 环境依赖
|
||||
|
||||
- `node`: lts/erbium (v12.\*)
|
||||
- `yarn`: 1.22.4 +
|
||||
|
||||
## 本地环境搭建
|
||||
|
||||
以 CentOS 为例
|
||||
|
||||
- 安装 nvm (nodejs 版本管理工具)
|
||||
|
||||
```shell
|
||||
wget -P /root/ --tries=10 --retry-connrefused --waitretry=60 --no-dns-cache --no-cache https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh
|
||||
bash /root/install.sh
|
||||
. /root/.nvm/nvm.sh
|
||||
```
|
||||
|
||||
- 安装 nodejs
|
||||
|
||||
```shell
|
||||
NODE_VERSION=erbium
|
||||
nvm install --lts=$NODE_VERSION
|
||||
nvm alias default lts/$NODE_VERSION
|
||||
nvm use default
|
||||
```
|
||||
|
||||
- 验证 nodejs 和 npm 版本
|
||||
|
||||
```shell
|
||||
node -v
|
||||
# v12.*.*
|
||||
npm -v
|
||||
# 6.*.*
|
||||
```
|
||||
|
||||
- 安装 yarn
|
||||
|
||||
```shell
|
||||
npm install -g yarn
|
||||
```
|
||||
|
||||
- 安装项目依赖
|
||||
|
||||
在项目根目录下，`package.json`同级。
|
||||
|
||||
```shell
|
||||
yarn install
|
||||
```
|
||||
|
||||
等待安装完成即可。
|
||||
|
||||
## 开发使用方法
|
||||
|
||||
在项目根目录下，`package.json`同级。
|
||||
|
||||
- `yarn run mock`: 使用[rap2](http://rap2.taobao.org/)工具 mock 接口
|
||||
- `yarn run dev`: 使用实际接口，需要将`webpack.dev.js`文件第 47 行的 "http://pre.xxx.com"
|
||||
修改为实际地址
|
||||
- `yarn run build`: 构建打包，可将生成的 dist 目录的内容交给后端
|
||||
|
||||
## 文档
|
||||
|
||||
### 如何开发
|
||||
|
||||
- [开发前的准备](docs/zh/develop/1-ready-to-work.md)
|
||||
- [目录结构](docs/zh/develop/2-catalog-introduction.md)
|
||||
- [开发一个资源的页面](docs/zh/develop/3-0-how-to-develop.md)
|
||||
- [BaseList 介绍](docs/zh/develop/3-1-BaseList-introduction.md)
|
||||
- [BaseTabList 介绍](docs/zh/develop/3-2-BaseTabList-introduction.md)
|
||||
- [BaseDetail 介绍](docs/zh/develop/3-3-BaseDetail-introduction.md)
|
||||
- [BaseDetailInfo 介绍](docs/zh/develop/3-4-BaseDetailInfo-introduction.md)
|
||||
- [BaseStore 介绍](docs/zh/develop/3-5-BaseStore-introduction.md)
|
||||
- [FormAction 介绍](docs/zh/develop/3-6-FormAction-introduction.md)
|
||||
- [ModalAction 介绍](docs/zh/develop/3-7-ModalAction-introduction.md)
|
||||
- [ConfirmAction 介绍](docs/zh/develop/3-8-ConfirmAction-introduction.md)
|
||||
- [StepAction 介绍](docs/zh/develop/3-9-StepAction-introduction.md)
|
||||
- [FormItem 介绍](docs/zh/develop/3-10-FormItem-introduction.md)
|
||||
- [Action 介绍](docs/zh/develop/3-11-Action-introduction.md)
|
||||
- [Menu 介绍](docs/zh/develop/3-12-Menu-introduction.md)
|
||||
- [Route 介绍](docs/zh/develop/3-13-Route-introduction.md)
|
||||
- [I18n 介绍](docs/zh/develop/3-14-I18n-introduction.md)
|
||||
|
||||
### 如何测试
|
||||
|
||||
- [两种不同的测试方式](docs/zh/test/1-ready-to-work.md)
|
||||
- [目录结构](docs/zh/test/2-catalog-introduction.md)
|
||||
- [如何修改 e2e 测试用例](docs/zh/test/3-0-how-to-edit-e2e-case.md)
|
||||
- [E2E - 表单操作](docs/zh/test/3-1-E2E-form-operation.md)
|
||||
- [E2E - 列表页操作](docs/zh/test/3-2-E2E-table-operation.md)
|
||||
- [E2E - 详情页操作](docs/zh/test/3-3-E2E-detail-operation.md)
|
||||
- [E2E - 资源操作](docs/zh/test/3-4-E2E-resource-operation.md)
|
||||
|
|
@ -0,0 +1,126 @@
|
|||
使用说明
|
||||
========
|
||||
|
||||
简体中文 \| `English <./README.md>`__
|
||||
|
||||
**目录**
|
||||
|
||||
- `使用说明 <#使用说明>`__
|
||||
|
||||
- `资源 <#资源>`__
|
||||
- `环境依赖 <#环境依赖>`__
|
||||
- `本地环境搭建 <#本地环境搭建>`__
|
||||
- `开发使用方法 <#开发使用方法>`__
|
||||
- `文档 <#文档>`__
|
||||
|
||||
- `如何开发 <#如何开发>`__
|
||||
- `如何测试 <#如何测试>`__
|
||||
|
||||
资源
|
||||
----
|
||||
|
||||
- `Wiki <https://wiki.openstack.org/wiki/Skyline>`__
|
||||
- `Bug 跟踪器 <https://launchpad.net/skyline-apiserver>`__
|
||||
|
||||
环境依赖
|
||||
--------
|
||||
|
||||
- ``node``: lts/erbium (v12.*)
|
||||
- ``yarn``: 1.22.4 +
|
||||
|
||||
本地环境搭建
|
||||
------------
|
||||
|
||||
以 CentOS 为例
|
||||
|
||||
- 安装 nvm (nodejs 版本管理工具)
|
||||
|
||||
.. code:: shell
|
||||
|
||||
wget -P /root/ --tries=10 --retry-connrefused --waitretry=60 --no-dns-cache --no-cache https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh
|
||||
bash /root/install.sh
|
||||
. /root/.nvm/nvm.sh
|
||||
|
||||
- 安装 nodejs
|
||||
|
||||
.. code:: shell
|
||||
|
||||
NODE_VERSION=erbium
|
||||
nvm install --lts=$NODE_VERSION
|
||||
nvm alias default lts/$NODE_VERSION
|
||||
nvm use default
|
||||
|
||||
- 验证 nodejs 和 npm 版本
|
||||
|
||||
.. code:: shell
|
||||
|
||||
node -v
|
||||
# v12.*.*
|
||||
npm -v
|
||||
# 6.*.*
|
||||
|
||||
- 安装 yarn
|
||||
|
||||
.. code:: shell
|
||||
|
||||
npm install -g yarn
|
||||
|
||||
- 安装项目依赖
|
||||
|
||||
在项目根目录下，\ ``package.json``\ 同级。
|
||||
|
||||
.. code:: shell
|
||||
|
||||
yarn install
|
||||
|
||||
等待安装完成即可。
|
||||
|
||||
开发使用方法
|
||||
------------
|
||||
|
||||
在项目根目录下，\ ``package.json``\ 同级。
|
||||
|
||||
- ``yarn run mock``: 使用\ `rap2 <http://rap2.taobao.org/>`__\ 工具
|
||||
mock 接口
|
||||
- ``yarn run dev``: 使用实际接口，需要将\ ``webpack.dev.js``\ 文件第 47
|
||||
行的 “http://pre.xxx.com” 修改为实际地址
|
||||
- ``yarn run build``: 构建打包，可将生成的 dist 目录的内容交给后端
|
||||
|
||||
文档
|
||||
----
|
||||
|
||||
如何开发
|
||||
~~~~~~~~
|
||||
|
||||
- `开发前的准备 <docs/zh/develop/1-ready-to-work.md>`__
|
||||
- `目录结构 <docs/zh/develop/2-catalog-introduction.md>`__
|
||||
- `开发一个资源的页面 <docs/zh/develop/3-0-how-to-develop.md>`__
|
||||
- `BaseList 介绍 <docs/zh/develop/3-1-BaseList-introduction.md>`__
|
||||
- `BaseTabList
|
||||
介绍 <docs/zh/develop/3-2-BaseTabList-introduction.md>`__
|
||||
- `BaseDetail 介绍 <docs/zh/develop/3-3-BaseDetail-introduction.md>`__
|
||||
- `BaseDetailInfo
|
||||
介绍 <docs/zh/develop/3-4-BaseDetailInfo-introduction.md>`__
|
||||
- `BaseStore 介绍 <docs/zh/develop/3-5-BaseStore-introduction.md>`__
|
||||
- `FormAction 介绍 <docs/zh/develop/3-6-FormAction-introduction.md>`__
|
||||
- `ModalAction
|
||||
介绍 <docs/zh/develop/3-7-ModalAction-introduction.md>`__
|
||||
- `ConfirmAction
|
||||
介绍 <docs/zh/develop/3-8-ConfirmAction-introduction.md>`__
|
||||
- `StepAction 介绍 <docs/zh/develop/3-9-StepAction-introduction.md>`__
|
||||
- `FormItem 介绍 <docs/zh/develop/3-10-FormItem-introduction.md>`__
|
||||
- `Action 介绍 <docs/zh/develop/3-11-Action-introduction.md>`__
|
||||
- `Menu 介绍 <docs/zh/develop/3-12-Menu-introduction.md>`__
|
||||
- `Route 介绍 <docs/zh/develop/3-13-Route-introduction.md>`__
|
||||
- `I18n 介绍 <docs/zh/develop/3-14-I18n-introduction.md>`__
|
||||
|
||||
如何测试
|
||||
~~~~~~~~
|
||||
|
||||
- `两种不同的测试方式 <docs/zh/test/1-ready-to-work.md>`__
|
||||
- `目录结构 <docs/zh/test/2-catalog-introduction.md>`__
|
||||
- `如何修改 e2e 测试用例 <docs/zh/test/3-0-how-to-edit-e2e-case.md>`__
|
||||
- `E2E - 表单操作 <docs/zh/test/3-1-E2E-form-operation.md>`__
|
||||
- `E2E - 列表页操作 <docs/zh/test/3-2-E2E-table-operation.md>`__
|
||||
- `E2E - 详情页操作 <docs/zh/test/3-3-E2E-detail-operation.md>`__
|
||||
- `E2E - 资源操作 <docs/zh/test/3-4-E2E-resource-operation.md>`__
|
||||
108
README.md
108
README.md
|
|
@ -1,108 +0,0 @@
|
|||
# Instructions
|
||||
|
||||
[简体中文](./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.\*)
|
||||
- `yarn`: 1.22.4 +
|
||||
|
||||
## Local Environment
|
||||
|
||||
Take CentOS as an example
|
||||
|
||||
- Install nvm ( version control system for nodejs )
|
||||
|
||||
```shell
|
||||
wget -P /root/ --tries=10 --retry-connrefused --waitretry=60 --no-dns-cache --no-cache https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh
|
||||
bash /root/install.sh
|
||||
. /root/.nvm/nvm.sh
|
||||
```
|
||||
|
||||
- Install nodejs
|
||||
|
||||
```shell
|
||||
NODE_VERSION=erbium
|
||||
nvm install --lts=$NODE_VERSION
|
||||
nvm alias default lts/$NODE_VERSION
|
||||
nvm use default
|
||||
```
|
||||
|
||||
- Verify nodejs and npm versions
|
||||
|
||||
```shell
|
||||
node -v
|
||||
# v12.*.*
|
||||
npm -v
|
||||
# 6.*.*
|
||||
```
|
||||
|
||||
- Install yarn
|
||||
|
||||
```shell
|
||||
npm install -g yarn
|
||||
```
|
||||
|
||||
- Install the project dependency under the root directory, with `package.json`in the same place.
|
||||
|
||||
```shell
|
||||
yarn install
|
||||
```
|
||||
|
||||
After those steps, please just wait until the installation is complete.
|
||||
|
||||
## Usage
|
||||
|
||||
Under the root directory, with `package.json` in the same place.
|
||||
|
||||
- `yarn run mock`: Use the mock interface of [rap2](http://rap2.taobao.org/)
|
||||
- `yarn run dev`: To use the actual interface，please change the "http://pre.xxx.com" in line 47 into the real address in file `webpack.dev.js`.
|
||||
- `yarn run build`: Build packages and then you can hand over the contents of the generated _dist_ directory to the back end.
|
||||
|
||||
## Docs
|
||||
|
||||
### How to develop
|
||||
|
||||
- [Preparation before development](docs/en/develop/1-ready-to-work.md)
|
||||
- [Directory structure](docs/en/develop/2-catalog-introduction.md)
|
||||
- [Develop a new resource page](docs/en/develop/3-0-how-to-develop.md)
|
||||
- [BaseList introduction](docs/en/develop/3-1-BaseList-introduction.md)
|
||||
- [BaseTabList introduction](docs/en/develop/3-2-BaseTabList-introduction.md)
|
||||
- [BaseDetail introduction](docs/en/develop/3-3-BaseDetail-introduction.md)
|
||||
- [BaseDetailInfo introduction](docs/en/develop/3-4-BaseDetailInfo-introduction.md)
|
||||
- [BaseStore introduction](docs/en/develop/3-5-BaseStore-introduction.md)
|
||||
- [FormAction introduction](docs/en/develop/3-6-FormAction-introduction.md)
|
||||
- [ModalAction introduction](docs/en/develop/3-7-ModalAction-introduction.md)
|
||||
- [ConfirmAction introduction](docs/en/develop/3-8-ConfirmAction-introduction.md)
|
||||
- [StepAction introduction](docs/en/develop/3-9-StepAction-introduction.md)
|
||||
- [FormItem introduction](docs/en/develop/3-10-FormItem-introduction.md)
|
||||
- [Action introduction](docs/en/develop/3-11-Action-introduction.md)
|
||||
- [Menu introduction](docs/en/develop/3-12-Menu-introduction.md)
|
||||
- [Route introduction](docs/en/develop/3-13-Route-introduction.md)
|
||||
- [I18n introduction](docs/en/develop/3-14-I18n-introduction.md)
|
||||
|
||||
### How to test
|
||||
|
||||
- [Two kinds of tests](docs/en/test/1-ready-to-work.md)
|
||||
- [Directory structure](docs/en/test/2-catalog-introduction.md)
|
||||
- [How to edit e2e case](docs/en/test/3-0-how-to-edit-e2e-case.md)
|
||||
- [E2E - Form operation](docs/en/test/3-1-E2E-form-operation.md)
|
||||
- [E2E - Table operation](docs/en/test/3-2-E2E-table-operation.md)
|
||||
- [E2E - Detail operation](docs/en/test/3-3-E2E-detail-operation.md)
|
||||
- [E2E - Resource operation](docs/en/test/3-4-E2E-resource-operation.md)
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
Instructions
|
||||
============
|
||||
|
||||
`简体中文 <./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.*)
|
||||
- ``yarn``: 1.22.4 +
|
||||
|
||||
Local Environment
|
||||
-----------------
|
||||
|
||||
Take CentOS as an example
|
||||
|
||||
- Install nvm ( version control system for nodejs )
|
||||
|
||||
.. code:: shell
|
||||
|
||||
wget -P /root/ --tries=10 --retry-connrefused --waitretry=60 --no-dns-cache --no-cache https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh
|
||||
bash /root/install.sh
|
||||
. /root/.nvm/nvm.sh
|
||||
|
||||
- Install nodejs
|
||||
|
||||
.. code:: shell
|
||||
|
||||
NODE_VERSION=erbium
|
||||
nvm install --lts=$NODE_VERSION
|
||||
nvm alias default lts/$NODE_VERSION
|
||||
nvm use default
|
||||
|
||||
- Verify nodejs and npm versions
|
||||
|
||||
.. code:: shell
|
||||
|
||||
node -v
|
||||
# v12.*.*
|
||||
npm -v
|
||||
# 6.*.*
|
||||
|
||||
- Install yarn
|
||||
|
||||
.. code:: shell
|
||||
|
||||
npm install -g yarn
|
||||
|
||||
- Install the project dependency under the root directory, with
|
||||
``package.json``\ in the same place.
|
||||
|
||||
.. code:: shell
|
||||
|
||||
yarn install
|
||||
|
||||
After those steps, please just wait until the installation is
|
||||
complete.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Under the root directory, with ``package.json`` in the same place.
|
||||
|
||||
- ``yarn run mock``: Use the mock interface of
|
||||
`rap2 <http://rap2.taobao.org/>`__
|
||||
- ``yarn run dev``: To use the actual interface, please change the
|
||||
“http://pre.xxx.com” in line 47 into the real address in file
|
||||
``webpack.dev.js``.
|
||||
- ``yarn run build``: Build packages and then you can hand over the
|
||||
contents of the generated *dist* directory to the back end.
|
||||
|
||||
Docs
|
||||
----
|
||||
|
||||
How to develop
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
- `Preparation before
|
||||
development <docs/en/develop/1-ready-to-work.md>`__
|
||||
- `Directory structure <docs/en/develop/2-catalog-introduction.md>`__
|
||||
- `Develop a new resource
|
||||
page <docs/en/develop/3-0-how-to-develop.md>`__
|
||||
- `BaseList
|
||||
introduction <docs/en/develop/3-1-BaseList-introduction.md>`__
|
||||
- `BaseTabList
|
||||
introduction <docs/en/develop/3-2-BaseTabList-introduction.md>`__
|
||||
- `BaseDetail
|
||||
introduction <docs/en/develop/3-3-BaseDetail-introduction.md>`__
|
||||
- `BaseDetailInfo
|
||||
introduction <docs/en/develop/3-4-BaseDetailInfo-introduction.md>`__
|
||||
- `BaseStore
|
||||
introduction <docs/en/develop/3-5-BaseStore-introduction.md>`__
|
||||
- `FormAction
|
||||
introduction <docs/en/develop/3-6-FormAction-introduction.md>`__
|
||||
- `ModalAction
|
||||
introduction <docs/en/develop/3-7-ModalAction-introduction.md>`__
|
||||
- `ConfirmAction
|
||||
introduction <docs/en/develop/3-8-ConfirmAction-introduction.md>`__
|
||||
- `StepAction
|
||||
introduction <docs/en/develop/3-9-StepAction-introduction.md>`__
|
||||
- `FormItem
|
||||
introduction <docs/en/develop/3-10-FormItem-introduction.md>`__
|
||||
- `Action introduction <docs/en/develop/3-11-Action-introduction.md>`__
|
||||
- `Menu introduction <docs/en/develop/3-12-Menu-introduction.md>`__
|
||||
- `Route introduction <docs/en/develop/3-13-Route-introduction.md>`__
|
||||
- `I18n introduction <docs/en/develop/3-14-I18n-introduction.md>`__
|
||||
|
||||
How to test
|
||||
~~~~~~~~~~~
|
||||
|
||||
- `Two kinds of tests <docs/en/test/1-ready-to-work.md>`__
|
||||
- `Directory structure <docs/en/test/2-catalog-introduction.md>`__
|
||||
- `How to edit e2e case <docs/en/test/3-0-how-to-edit-e2e-case.md>`__
|
||||
- `E2E - Form operation <docs/en/test/3-1-E2E-form-operation.md>`__
|
||||
- `E2E - Table operation <docs/en/test/3-2-E2E-table-operation.md>`__
|
||||
- `E2E - Detail operation <docs/en/test/3-3-E2E-detail-operation.md>`__
|
||||
- `E2E - Resource
|
||||
operation <docs/en/test/3-4-E2E-resource-operation.md>`__
|
||||
Loading…
Reference in New Issue