openstack
/
qinling
Code Issues Proposed changes

Update qinling doc location to docs.openstack.org 

This commit also adds a missing markup in the quick start guide.

Co-Authored-By: Hunt Xu <mhuntxu@gmail.com>

Change-Id: I670c4a5231f8595a405589855eafd7667c606614
This commit is contained in:
caoyuan 2018-02-27 22:40:01 +08:00 committed by Hunt Xu
parent 1be8f87390
commit b0d724a338
4 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -16,7 +16,7 @@ different function package storage backends (local/Swift/S3) by nature using
plugin mechanism. plugin mechanism.
* Free software: Apache license * Free software: Apache license
* Documentation: http://qinling.readthedocs.io/ * Documentation: https://docs.openstack.org/qinling/latest/
* Source: http://git.openstack.org/cgit/openstack/qinling * Source: http://git.openstack.org/cgit/openstack/qinling
* Features: https://storyboard.openstack.org/#!/project/927 * Features: https://storyboard.openstack.org/#!/project/927
* Bug Track: https://storyboard.openstack.org/#!/project/927 * Bug Track: https://storyboard.openstack.org/#!/project/927

2
doc/README.rst
View File

@ -6,7 +6,7 @@ Files under this directory tree are used for generating the documentation
for the qinling source code. for the qinling source code.
Developer documentation is built to: Developer documentation is built to:
http://qinling.readthedocs.io/en/latest/ https://docs.openstack.org/qinling/latest/
Tools Tools
===== =====

2
doc/source/index.rst
View File

@ -28,7 +28,7 @@ availability. You can set up your code to automatically trigger from other
OpenStack services or call it directly from any web or mobile app. OpenStack services or call it directly from any web or mobile app.
* Free software: Apache license * Free software: Apache license
* Documentation: http://qinling.readthedocs.io/ * Documentation: https://docs.openstack.org/qinling/latest/
* Source: http://git.openstack.org/cgit/openstack/qinling * Source: http://git.openstack.org/cgit/openstack/qinling
* Features: https://storyboard.openstack.org/#!/project/927 * Features: https://storyboard.openstack.org/#!/project/927
* Bug Track: https://storyboard.openstack.org/#!/project/927 * Bug Track: https://storyboard.openstack.org/#!/project/927

8
doc/source/quick_start.rst
View File

@ -6,9 +6,8 @@ Installation
A fast and simple way to try Qinling is to create a Devstack environment A fast and simple way to try Qinling is to create a Devstack environment
including all related components and dependencies of Qinling service. Please including all related components and dependencies of Qinling service. Please
refer to refer to `Setting up a development environment with devstack`_ for how to
http://qinling.readthedocs.io/en/latest/contributor/development-environment-devstack.html install Qinling service in OpenStack devstack environment.
for how to install Qinling service in OpenStack devstack environment.
Qinling is a FaaS implemented on top of container orchestration system such as Qinling is a FaaS implemented on top of container orchestration system such as
Kubernetes, Swarm, etc. Particularly, Kubernetes is a reference backend Kubernetes, Swarm, etc. Particularly, Kubernetes is a reference backend
@ -19,6 +18,9 @@ Qinling can work with OpenStack Keystone for authentication, or it can work
without authentication at all. By default, authentication is enabled, set without authentication at all. By default, authentication is enabled, set
``auth_enable = False`` to disable authentication. ``auth_enable = False`` to disable authentication.
.. _Setting up a development environment with devstack: https://docs.openstack.org/qinling/latest/contributor/development-environment-devstack.html
Getting started with Qinling Getting started with Qinling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~