Browse Source

Outline for Qinling doc

Change-Id: I37daf816e30babfecffed3d91f8782929124e3ae
Story: 2001577
Task: 6526
changes/81/565381/1
Lingxian Kong 3 years ago
parent
commit
e22faa69fd
  1. 1
      doc/source/admin/index.rst
  2. 29
      doc/source/admin/installation.rst
  3. 2
      doc/source/features.rst
  4. 21
      doc/source/glossary.rst
  5. 9
      doc/source/index.rst
  6. 28
      doc/source/user/index.rst

1
doc/source/admin/index.rst

@ -21,6 +21,7 @@ Administration/Operation Guide
.. toctree::
:maxdepth: 1
installation
runtime
security

29
doc/source/admin/installation.rst

@ -0,0 +1,29 @@
..
Copyright 2018 Catalyst IT Ltd
All Rights Reserved.
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Installation Guide
==================
Install Qinling in DevStack
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Refer to
`Developer Guide <https://docs.openstack.org/qinling/latest/contributor/development-environment-devstack.html>`_
Config Qinling using existing Kubernetes cluster
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In most cases, it's not ideal to set up a new dedicated kubernetes cluster for
Qinling. Follow the steps below to config Qinling work with the existing
kubernetes cluster

2
doc/source/features.rst

@ -12,7 +12,7 @@
License for the specific language governing permissions and limitations
under the License.
Qinling features
Qinling Features
================
This section does not intend to give you an exhaustive feature list of Qinling,

21
doc/source/glossary.rst

@ -0,0 +1,21 @@
..
Copyright 2018 Catalyst IT Ltd
All Rights Reserved.
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Qinling Glossary
================
As the Qinling project evolves, it’s important that people working on Qinling,
users using Qinling, and operators deploying Qinling use a common set of
terminology in order to avoid misunderstandings and confusion. To that end, we
are providing the following glossary of terms.

9
doc/source/index.rst

@ -42,6 +42,7 @@ Overview
:maxdepth: 1
quick_start
glossary
features
Administration/Operation Guide
@ -61,6 +62,14 @@ Contributor/Developer Guide
contributor/index
specs/index
User Guide
----------
.. toctree::
:maxdepth: 1
user/index
Function Programming Guide
--------------------------

28
doc/source/user/index.rst

@ -0,0 +1,28 @@
..
Copyright 2010-2011 United States Government as represented by the
Administrator of the National Aeronautics and Space Administration.
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
User Guide
==========
.. toctree::
:maxdepth: 1
Indices and tables
------------------
* :ref:`genindex`
* :ref:`search`
Loading…
Cancel
Save