From b0d724a3389af4eb35b2a4090ac7c34e056a6033 Mon Sep 17 00:00:00 2001 From: caoyuan Date: Tue, 27 Feb 2018 22:40:01 +0800 Subject: [PATCH] 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 Change-Id: I670c4a5231f8595a405589855eafd7667c606614 --- README.rst | 2 +- doc/README.rst | 2 +- doc/source/index.rst | 2 +- doc/source/quick_start.rst | 8 +++++--- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 1c4c6e23..23ecb411 100644 --- a/README.rst +++ b/README.rst @@ -16,7 +16,7 @@ different function package storage backends (local/Swift/S3) by nature using plugin mechanism. * Free software: Apache license -* Documentation: http://qinling.readthedocs.io/ +* Documentation: https://docs.openstack.org/qinling/latest/ * Source: http://git.openstack.org/cgit/openstack/qinling * Features: https://storyboard.openstack.org/#!/project/927 * Bug Track: https://storyboard.openstack.org/#!/project/927 diff --git a/doc/README.rst b/doc/README.rst index 531ed25c..391a1468 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -6,7 +6,7 @@ Files under this directory tree are used for generating the documentation for the qinling source code. Developer documentation is built to: -http://qinling.readthedocs.io/en/latest/ +https://docs.openstack.org/qinling/latest/ Tools ===== diff --git a/doc/source/index.rst b/doc/source/index.rst index cbc19b5c..7275ec37 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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. * Free software: Apache license -* Documentation: http://qinling.readthedocs.io/ +* Documentation: https://docs.openstack.org/qinling/latest/ * Source: http://git.openstack.org/cgit/openstack/qinling * Features: https://storyboard.openstack.org/#!/project/927 * Bug Track: https://storyboard.openstack.org/#!/project/927 diff --git a/doc/source/quick_start.rst b/doc/source/quick_start.rst index 05e03c2b..2daef398 100644 --- a/doc/source/quick_start.rst +++ b/doc/source/quick_start.rst @@ -6,9 +6,8 @@ Installation A fast and simple way to try Qinling is to create a Devstack environment including all related components and dependencies of Qinling service. Please -refer to -http://qinling.readthedocs.io/en/latest/contributor/development-environment-devstack.html -for how to install Qinling service in OpenStack devstack environment. +refer to `Setting up a development environment with devstack`_ for how to +install Qinling service in OpenStack devstack environment. Qinling is a FaaS implemented on top of container orchestration system such as 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 ``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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~