Rearrange existing documentation to fit the new standard layout

For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I85c8999eb12065662c02879beb7dd31d6178fe7e
This commit is contained in:
dharmendra 2017-07-06 10:07:06 +00:00
parent 1dd3762554
commit 4e06cc4d1e
26 changed files with 35 additions and 27 deletions

View File

@ -23,7 +23,7 @@ Tacker launchpad [#]_ bug.
* Once all the patchsets are merged the bug will be moved to the "Completed"
state.
* Developer(s) are expected to add a devref describing the usage of the feature
and other related topics in tacker/doc/source/devref directory.
and other related topics in tacker/doc/source/contributor directory.
This process is recommended for smaller enhancements that can be described
easily and it is relatively easy to implement in a short period of time.
@ -49,7 +49,7 @@ submitting a patchset to the tacker-spec repository [#]_.
* Once all the patchsets are merged the blueprint will be as "Implemented" by
the tacker core team.
* The developer is expected to add a devref describing the usage of the feature
and other related topics in tacker/doc/source/devref directory.
and other related topics in tacker/doc/source/contributor directory.
This process is recommended for medium to large enhancements that needs
significant code-changes (LOC), community discussions and debates.

View File

@ -49,30 +49,38 @@ Feature Documentation
.. toctree::
:maxdepth: 1
devref/vnfm_usage_guide.rst
devref/vnfd_template_description.rst
devref/monitor-api.rst
devref/vnfd_template_parameterization.rst
devref/enhanced_placement_awareness_usage_guide.rst
devref/multisite_vim_usage_guide.rst
devref/mistral_workflows_usage_guide.rst
devref/scale_usage_guide.rst
devref/alarm_monitoring_usage_guide.rst
devref/event_logging.rst
devref/vnffgd_template_description.rst
devref/vnffg_usage_guide.rst
devref/nsd_usage_guide.rst
devref/vnf_component_usage_guide.rst
devref/tacker_conductor.rst
devref/tacker_vim_monitoring.rst
contributor/vnfd_template_description.rst
contributor/monitor-api.rst
contributor/vnfd_template_parameterization.rst
contributor/event_logging.rst
contributor/vnffgd_template_description.rst
contributor/tacker_conductor.rst
contributor/tacker_vim_monitoring.rst
contributor/policy_actions_framework.rst
User Guide
==========
.. toctree::
:maxdepth: 1
user/vnfm_usage_guide.rst
user/multisite_vim_usage_guide.rst
user/scale_usage_guide.rst
user/alarm_monitoring_usage_guide.rst
user/vnffg_usage_guide.rst
user/nsd_usage_guide.rst
user/vnf_component_usage_guide.rst
user/enhanced_placement_awareness_usage_guide.rst
reference/mistral_workflows_usage_guide.rst
API Documentation
=================
.. toctree::
:maxdepth: 1
:maxdepth: 2
devref/mano_api.rst
contributor/api/mano_api.rst
Contributing to Tacker
======================
@ -80,7 +88,7 @@ Contributing to Tacker
.. toctree::
:maxdepth: 1
policies/dev-process.rst
contributor/dev-process.rst
Developer Info
==============
@ -88,11 +96,11 @@ Developer Info
.. toctree::
:maxdepth: 1
devref/development.environment.rst
devref/api_layer.rst
devref/api_extensions.rst
devref/tacker_functional_test.rst
devref/dashboards.rst
contributor/development.environment.rst
contributor/api/api_layer.rst
contributor/api/api_extensions.rst
contributor/tacker_functional_test.rst
contributor/dashboards.rst
Project Info
============

View File

@ -25,7 +25,7 @@ decides which traffic should go through them.
Similar to how VNFs are described by VNFDs, VNFFGs are described by VNF
Forwarding Graph Descriptors (VNFFGD). Please see the `devref guide
<https://github.com/openstack/tacker/blob/master/doc/source/devref
<https://github.com/openstack/tacker/blob/master/doc/source/contributor
/vnffgd_template_description.rst>`_ on VNFFGD to learn more about
how a VNFFGD is defined.