skyline-apiserver/doc/source/index.rst
Boxiang Zhu 7ba07dbf70 feat: Add doc base frame
Add doc base frame

Change-Id: Id0a4168873232ef7feedaf1e1c1b6ed2b69a8f17
2022-07-29 14:31:57 +08:00

95 lines
1.7 KiB
ReStructuredText

..
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.
============================================================
OpenStack Modern Dashboard (Skyline APIServer) documentation
============================================================
What is Skyline APIServer?
--------------------------
Skyline APIServer is one part of the OpenStack Modern Dashboard for providing
restful api.
For end users
-------------
As an end user, we don't suggest you to use this Skyline APIServer directly.
Instead, you should use Skyline Dashboard(With Skyline Console).
For operators
-------------
Installing Skyline APIServer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
install/index
Administrating Skyline APIServer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Contents:
.. toctree::
:maxdepth: 1
admin/index
Reference
~~~~~~~~~
Contents:
.. toctree::
:maxdepth: 1
configuration/index
cli/index
Additional resources
~~~~~~~~~~~~~~~~~~~~
For contributors
----------------
.. toctree::
:maxdepth: 1
contributor/index
Additional reference
~~~~~~~~~~~~~~~~~~~~
Contents:
.. toctree::
:maxdepth: 1
reference/index
.. only:: html
Additional reference
~~~~~~~~~~~~~~~~~~~~
Contents:
* :ref:`genindex`