Files
tacker/doc/source/index.rst
Ai Hamano 9e4d92feac Improve document structure
This patch fixes the documentation structure for:
- Move Overview from UserGuide to top page
- Move OAuth2.0, OpenID and DB migration tool documentation
  to AdminGuide
- Move Policy documentation to ConfigurationGuide
- Add `Tools` to Reference
- Move FaultNotification documentation to `Management Driver`
- Move Prometheus documentation to `Prometheus Plugin`
- Add link to command list and ConfigurationGuide to AdminGuide
- Add `VNF Package` to `v1/v2 Tacker Use Cases`
  and move VNF Package sample documentation to `VNF Package`
- Move Coordinate API client script documentation
  to `Change Current VNF Package`

Change-Id: Ie8a1df67266d90e3960060d922786d22352619d6
2023-11-21 17:21:16 +09:00

78 lines
2.2 KiB
ReStructuredText

..
Copyright 2014-2015 OpenStack Foundation
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.
===============================
Welcome to Tacker Documentation
===============================
Tacker is an OpenStack service for NFV Orchestration with a general purpose VNF
Manager to deploy and operate Virtual Network Functions (VNFs) and Network
Services on an NFV Platform. It is based on ETSI MANO Architectural Framework
and provides `OpenStack's NFV Orchestration API
<https://docs.openstack.org/api-ref/nfv-orchestration/>`_.
Overview
--------
.. toctree::
:maxdepth: 2
user/introduction
user/architecture
user/resources
Contents
--------
.. toctree::
:maxdepth: 2
install/index
user/index
admin/index
configuration/index
cli/index
contributor/index
reference/index
Release Notes
-------------
.. toctree::
:maxdepth: 1
Release Notes <https://docs.openstack.org/releasenotes/tacker>
Project Info
------------
* **Free software:** under the `Apache license <https://www.apache.org/licenses/LICENSE-2.0>`_
* **Tacker Service:** https://opendev.org/openstack/tacker
* **Tacker Horizon:** https://opendev.org/openstack/tacker-horizon
* **Tacker Specs:** https://opendev.org/openstack/tacker-specs
* **Tacker Specs Documentation:** https://specs.openstack.org/openstack/tacker-specs
* **Tacker Client Library:** https://opendev.org/openstack/python-tackerclient
* **Tacker Bugs:** https://bugs.launchpad.net/tacker
* **Client Bugs:** https://bugs.launchpad.net/python-tackerclient
* **Blueprints:** https://blueprints.launchpad.net/tacker
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`