From 4e06cc4d1e1527ac486e3afaf5b56a4a0e4dd88e Mon Sep 17 00:00:00 2001 From: dharmendra Date: Thu, 6 Jul 2017 10:07:06 +0000 Subject: [PATCH] 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 --- .../api}/api_extensions.rst | 0 .../{devref => contributor/api}/api_layer.rst | 0 .../{devref => contributor/api}/mano_api.rst | 0 .../{devref => contributor}/dashboards.rst | 0 .../{policies => contributor}/dev-process.rst | 4 +- .../development.environment.rst | 0 .../encrypt_vim_auth_with_barbican.rst | 0 .../{devref => contributor}/event_logging.rst | 0 .../{devref => contributor}/monitor-api.rst | 0 .../policy_actions_framework.rst | 0 .../tacker_conductor.rst | 0 .../tacker_functional_test.rst | 0 .../tacker_vim_monitoring.rst | 0 .../vnfd_template_description.rst | 0 .../vnfd_template_parameterization.rst | 0 .../vnffgd_template_description.rst | 0 doc/source/index.rst | 56 +++++++++++-------- .../mistral_workflows_usage_guide.rst | 0 .../alarm_monitoring_usage_guide.rst | 0 ...hanced_placement_awareness_usage_guide.rst | 0 .../multisite_vim_usage_guide.rst | 0 .../{devref => user}/nsd_usage_guide.rst | 0 .../{devref => user}/scale_usage_guide.rst | 0 .../vnf_component_usage_guide.rst | 0 .../{devref => user}/vnffg_usage_guide.rst | 2 +- .../{devref => user}/vnfm_usage_guide.rst | 0 26 files changed, 35 insertions(+), 27 deletions(-) rename doc/source/{devref => contributor/api}/api_extensions.rst (100%) rename doc/source/{devref => contributor/api}/api_layer.rst (100%) rename doc/source/{devref => contributor/api}/mano_api.rst (100%) rename doc/source/{devref => contributor}/dashboards.rst (100%) rename doc/source/{policies => contributor}/dev-process.rst (95%) rename doc/source/{devref => contributor}/development.environment.rst (100%) rename doc/source/{devref => contributor}/encrypt_vim_auth_with_barbican.rst (100%) rename doc/source/{devref => contributor}/event_logging.rst (100%) rename doc/source/{devref => contributor}/monitor-api.rst (100%) rename doc/source/{devref => contributor}/policy_actions_framework.rst (100%) rename doc/source/{devref => contributor}/tacker_conductor.rst (100%) rename doc/source/{devref => contributor}/tacker_functional_test.rst (100%) rename doc/source/{devref => contributor}/tacker_vim_monitoring.rst (100%) rename doc/source/{devref => contributor}/vnfd_template_description.rst (100%) rename doc/source/{devref => contributor}/vnfd_template_parameterization.rst (100%) rename doc/source/{devref => contributor}/vnffgd_template_description.rst (100%) rename doc/source/{devref => reference}/mistral_workflows_usage_guide.rst (100%) rename doc/source/{devref => user}/alarm_monitoring_usage_guide.rst (100%) rename doc/source/{devref => user}/enhanced_placement_awareness_usage_guide.rst (100%) rename doc/source/{devref => user}/multisite_vim_usage_guide.rst (100%) rename doc/source/{devref => user}/nsd_usage_guide.rst (100%) rename doc/source/{devref => user}/scale_usage_guide.rst (100%) rename doc/source/{devref => user}/vnf_component_usage_guide.rst (100%) rename doc/source/{devref => user}/vnffg_usage_guide.rst (98%) rename doc/source/{devref => user}/vnfm_usage_guide.rst (100%) diff --git a/doc/source/devref/api_extensions.rst b/doc/source/contributor/api/api_extensions.rst similarity index 100% rename from doc/source/devref/api_extensions.rst rename to doc/source/contributor/api/api_extensions.rst diff --git a/doc/source/devref/api_layer.rst b/doc/source/contributor/api/api_layer.rst similarity index 100% rename from doc/source/devref/api_layer.rst rename to doc/source/contributor/api/api_layer.rst diff --git a/doc/source/devref/mano_api.rst b/doc/source/contributor/api/mano_api.rst similarity index 100% rename from doc/source/devref/mano_api.rst rename to doc/source/contributor/api/mano_api.rst diff --git a/doc/source/devref/dashboards.rst b/doc/source/contributor/dashboards.rst similarity index 100% rename from doc/source/devref/dashboards.rst rename to doc/source/contributor/dashboards.rst diff --git a/doc/source/policies/dev-process.rst b/doc/source/contributor/dev-process.rst similarity index 95% rename from doc/source/policies/dev-process.rst rename to doc/source/contributor/dev-process.rst index 718f8f7de..0691ee3f3 100644 --- a/doc/source/policies/dev-process.rst +++ b/doc/source/contributor/dev-process.rst @@ -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. diff --git a/doc/source/devref/development.environment.rst b/doc/source/contributor/development.environment.rst similarity index 100% rename from doc/source/devref/development.environment.rst rename to doc/source/contributor/development.environment.rst diff --git a/doc/source/devref/encrypt_vim_auth_with_barbican.rst b/doc/source/contributor/encrypt_vim_auth_with_barbican.rst similarity index 100% rename from doc/source/devref/encrypt_vim_auth_with_barbican.rst rename to doc/source/contributor/encrypt_vim_auth_with_barbican.rst diff --git a/doc/source/devref/event_logging.rst b/doc/source/contributor/event_logging.rst similarity index 100% rename from doc/source/devref/event_logging.rst rename to doc/source/contributor/event_logging.rst diff --git a/doc/source/devref/monitor-api.rst b/doc/source/contributor/monitor-api.rst similarity index 100% rename from doc/source/devref/monitor-api.rst rename to doc/source/contributor/monitor-api.rst diff --git a/doc/source/devref/policy_actions_framework.rst b/doc/source/contributor/policy_actions_framework.rst similarity index 100% rename from doc/source/devref/policy_actions_framework.rst rename to doc/source/contributor/policy_actions_framework.rst diff --git a/doc/source/devref/tacker_conductor.rst b/doc/source/contributor/tacker_conductor.rst similarity index 100% rename from doc/source/devref/tacker_conductor.rst rename to doc/source/contributor/tacker_conductor.rst diff --git a/doc/source/devref/tacker_functional_test.rst b/doc/source/contributor/tacker_functional_test.rst similarity index 100% rename from doc/source/devref/tacker_functional_test.rst rename to doc/source/contributor/tacker_functional_test.rst diff --git a/doc/source/devref/tacker_vim_monitoring.rst b/doc/source/contributor/tacker_vim_monitoring.rst similarity index 100% rename from doc/source/devref/tacker_vim_monitoring.rst rename to doc/source/contributor/tacker_vim_monitoring.rst diff --git a/doc/source/devref/vnfd_template_description.rst b/doc/source/contributor/vnfd_template_description.rst similarity index 100% rename from doc/source/devref/vnfd_template_description.rst rename to doc/source/contributor/vnfd_template_description.rst diff --git a/doc/source/devref/vnfd_template_parameterization.rst b/doc/source/contributor/vnfd_template_parameterization.rst similarity index 100% rename from doc/source/devref/vnfd_template_parameterization.rst rename to doc/source/contributor/vnfd_template_parameterization.rst diff --git a/doc/source/devref/vnffgd_template_description.rst b/doc/source/contributor/vnffgd_template_description.rst similarity index 100% rename from doc/source/devref/vnffgd_template_description.rst rename to doc/source/contributor/vnffgd_template_description.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index a2dc52b86..feeb5419c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ============ diff --git a/doc/source/devref/mistral_workflows_usage_guide.rst b/doc/source/reference/mistral_workflows_usage_guide.rst similarity index 100% rename from doc/source/devref/mistral_workflows_usage_guide.rst rename to doc/source/reference/mistral_workflows_usage_guide.rst diff --git a/doc/source/devref/alarm_monitoring_usage_guide.rst b/doc/source/user/alarm_monitoring_usage_guide.rst similarity index 100% rename from doc/source/devref/alarm_monitoring_usage_guide.rst rename to doc/source/user/alarm_monitoring_usage_guide.rst diff --git a/doc/source/devref/enhanced_placement_awareness_usage_guide.rst b/doc/source/user/enhanced_placement_awareness_usage_guide.rst similarity index 100% rename from doc/source/devref/enhanced_placement_awareness_usage_guide.rst rename to doc/source/user/enhanced_placement_awareness_usage_guide.rst diff --git a/doc/source/devref/multisite_vim_usage_guide.rst b/doc/source/user/multisite_vim_usage_guide.rst similarity index 100% rename from doc/source/devref/multisite_vim_usage_guide.rst rename to doc/source/user/multisite_vim_usage_guide.rst diff --git a/doc/source/devref/nsd_usage_guide.rst b/doc/source/user/nsd_usage_guide.rst similarity index 100% rename from doc/source/devref/nsd_usage_guide.rst rename to doc/source/user/nsd_usage_guide.rst diff --git a/doc/source/devref/scale_usage_guide.rst b/doc/source/user/scale_usage_guide.rst similarity index 100% rename from doc/source/devref/scale_usage_guide.rst rename to doc/source/user/scale_usage_guide.rst diff --git a/doc/source/devref/vnf_component_usage_guide.rst b/doc/source/user/vnf_component_usage_guide.rst similarity index 100% rename from doc/source/devref/vnf_component_usage_guide.rst rename to doc/source/user/vnf_component_usage_guide.rst diff --git a/doc/source/devref/vnffg_usage_guide.rst b/doc/source/user/vnffg_usage_guide.rst similarity index 98% rename from doc/source/devref/vnffg_usage_guide.rst rename to doc/source/user/vnffg_usage_guide.rst index ccdbb32c7..19206aff2 100644 --- a/doc/source/devref/vnffg_usage_guide.rst +++ b/doc/source/user/vnffg_usage_guide.rst @@ -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 -`_ on VNFFGD to learn more about how a VNFFGD is defined. diff --git a/doc/source/devref/vnfm_usage_guide.rst b/doc/source/user/vnfm_usage_guide.rst similarity index 100% rename from doc/source/devref/vnfm_usage_guide.rst rename to doc/source/user/vnfm_usage_guide.rst