Adapt murano documentation for new standards

This patch set makes the following changes: * using the new standards * Update doc/source/index.rst with new links * Move content of install-guide to the doc/source/install Change-Id: Ic16671191832d949d2ea0626dcbf334ba60c56ef
2017-07-07 12:41:54 +08:00 · 2017-07-07 12:41:54 +08:00 · 9cb54690e9
commit 9cb54690e9
parent 5b51862ab7
185 changed files with 26 additions and 309 deletions
--- a/doc/source/administrator-guide/admin_index.rst
+++ b/doc/source/administrator-guide/admin_index.rst
@ -19,4 +19,5 @@ Deploying Murano
   policy_enf
   configure_cloud_foundry_service_broker
   using_glare.rst
-   admin_troubleshooting
+   admin_troubleshooting
+   appdev-guide/developer_index
--- a/doc/source/administrator-guide/admin_troubleshooting.rst
+++ b/doc/source/administrator-guide/admin_troubleshooting.rst
--- a/doc/source/admin/appdev-guide/app_debugging.rst
+++ b/doc/source/admin/appdev-guide/app_debugging.rst
--- a/doc/source/admin/appdev-guide/app_development_framework.rst
+++ b/doc/source/admin/appdev-guide/app_development_framework.rst
--- a/doc/source/admin/appdev-guide/app_migrating.rst
+++ b/doc/source/admin/appdev-guide/app_migrating.rst
--- a/doc/source/admin/appdev-guide/app_migrating/app_migrate_to_juno.rst
+++ b/doc/source/admin/appdev-guide/app_migrating/app_migrate_to_juno.rst
--- a/doc/source/admin/appdev-guide/app_migrating/app_migrate_to_kilo.rst
+++ b/doc/source/admin/appdev-guide/app_migrating/app_migrate_to_kilo.rst
--- a/doc/source/admin/appdev-guide/app_migrating/app_migrate_to_liberty.rst
+++ b/doc/source/admin/appdev-guide/app_migrating/app_migrate_to_liberty.rst
--- a/doc/source/admin/appdev-guide/app_migrating/app_migrate_to_newton.rst
+++ b/doc/source/admin/appdev-guide/app_migrating/app_migrate_to_newton.rst
--- a/doc/source/admin/appdev-guide/app_unit_tests.rst
+++ b/doc/source/admin/appdev-guide/app_unit_tests.rst
--- a/doc/source/admin/appdev-guide/cinder_volume_supporting.rst
+++ b/doc/source/admin/appdev-guide/cinder_volume_supporting.rst
--- a/doc/source/admin/appdev-guide/developer_index.rst
+++ b/doc/source/admin/appdev-guide/developer_index.rst
--- a/doc/source/admin/appdev-guide/examples.rst
+++ b/doc/source/admin/appdev-guide/examples.rst
--- a/doc/source/admin/appdev-guide/exec_plan.rst
+++ b/doc/source/admin/appdev-guide/exec_plan.rst
--- a/doc/source/admin/appdev-guide/faq.rst
+++ b/doc/source/admin/appdev-guide/faq.rst
--- a/doc/source/admin/appdev-guide/figures/chef_server.png
+++ b/doc/source/admin/appdev-guide/figures/chef_server.png
--- a/doc/source/admin/appdev-guide/figures/chef_server_form.png
+++ b/doc/source/admin/appdev-guide/figures/chef_server_form.png
--- a/doc/source/admin/appdev-guide/figures/logo.png
+++ b/doc/source/admin/appdev-guide/figures/logo.png
--- a/doc/source/admin/appdev-guide/figures/step_1.png
+++ b/doc/source/admin/appdev-guide/figures/step_1.png
--- a/doc/source/admin/appdev-guide/figures/step_2.png
+++ b/doc/source/admin/appdev-guide/figures/step_2.png
--- a/doc/source/admin/appdev-guide/figures/structure.png
+++ b/doc/source/admin/appdev-guide/figures/structure.png
--- a/doc/source/admin/appdev-guide/figures/structure.vdx
+++ b/doc/source/admin/appdev-guide/figures/structure.vdx
--- a/doc/source/admin/appdev-guide/garbage_collection.rst
+++ b/doc/source/admin/appdev-guide/garbage_collection.rst
--- a/doc/source/admin/appdev-guide/hot_packages.rst
+++ b/doc/source/admin/appdev-guide/hot_packages.rst
--- a/doc/source/admin/appdev-guide/multi_region.rst
+++ b/doc/source/admin/appdev-guide/multi_region.rst
--- a/doc/source/admin/appdev-guide/murano_bundles.rst
+++ b/doc/source/admin/appdev-guide/murano_bundles.rst
--- a/doc/source/admin/appdev-guide/murano_packages.rst
+++ b/doc/source/admin/appdev-guide/murano_packages.rst
--- a/doc/source/admin/appdev-guide/murano_pl.rst
+++ b/doc/source/admin/appdev-guide/murano_pl.rst
--- a/doc/source/admin/appdev-guide/murano_pl/actions.rst
+++ b/doc/source/admin/appdev-guide/murano_pl/actions.rst
--- a/doc/source/admin/appdev-guide/murano_pl/class_templ.rst
+++ b/doc/source/admin/appdev-guide/murano_pl/class_templ.rst
--- a/doc/source/admin/appdev-guide/murano_pl/core_lib.rst
+++ b/doc/source/admin/appdev-guide/murano_pl/core_lib.rst
--- a/doc/source/admin/appdev-guide/murano_pl/metadata.rst
+++ b/doc/source/admin/appdev-guide/murano_pl/metadata.rst
--- a/doc/source/admin/appdev-guide/murano_pl/reflection.rst
+++ b/doc/source/admin/appdev-guide/murano_pl/reflection.rst
--- a/doc/source/admin/appdev-guide/murano_pl/statics.rst
+++ b/doc/source/admin/appdev-guide/murano_pl/statics.rst
--- a/doc/source/admin/appdev-guide/murano_pl/versioning.rst
+++ b/doc/source/admin/appdev-guide/murano_pl/versioning.rst
--- a/doc/source/admin/appdev-guide/murano_pl/yaml.rst
+++ b/doc/source/admin/appdev-guide/murano_pl/yaml.rst
--- a/doc/source/admin/appdev-guide/murano_pl/yaql.rst
+++ b/doc/source/admin/appdev-guide/murano_pl/yaql.rst
--- a/doc/source/admin/appdev-guide/muranopackages/dynamic_ui.rst
+++ b/doc/source/admin/appdev-guide/muranopackages/dynamic_ui.rst
--- a/doc/source/admin/appdev-guide/muranopackages/package_structure.rst
+++ b/doc/source/admin/appdev-guide/muranopackages/package_structure.rst
--- a/doc/source/admin/appdev-guide/muranopackages/repository.rst
+++ b/doc/source/admin/appdev-guide/muranopackages/repository.rst
--- a/doc/source/admin/appdev-guide/step-by-step/configure-step1.png
+++ b/doc/source/admin/appdev-guide/step-by-step/configure-step1.png
--- a/doc/source/admin/appdev-guide/step-by-step/configure-step2.png
+++ b/doc/source/admin/appdev-guide/step-by-step/configure-step2.png
--- a/doc/source/admin/appdev-guide/step-by-step/hello-world-desc.png
+++ b/doc/source/admin/appdev-guide/step-by-step/hello-world-desc.png
--- a/doc/source/admin/appdev-guide/step-by-step/hello-world-screen-1.png
+++ b/doc/source/admin/appdev-guide/step-by-step/hello-world-screen-1.png
--- a/doc/source/admin/appdev-guide/step-by-step/hello-world-screen-2.png
+++ b/doc/source/admin/appdev-guide/step-by-step/hello-world-screen-2.png
--- a/doc/source/admin/appdev-guide/step-by-step/new-env-1.png
+++ b/doc/source/admin/appdev-guide/step-by-step/new-env-1.png
--- a/doc/source/admin/appdev-guide/step-by-step/new-env-2.png
+++ b/doc/source/admin/appdev-guide/step-by-step/new-env-2.png
--- a/doc/source/admin/appdev-guide/step-by-step/new-env-3.png
+++ b/doc/source/admin/appdev-guide/step-by-step/new-env-3.png
--- a/doc/source/admin/appdev-guide/step-by-step/part1.rst
+++ b/doc/source/admin/appdev-guide/step-by-step/part1.rst
--- a/doc/source/admin/appdev-guide/step-by-step/part2.rst
+++ b/doc/source/admin/appdev-guide/step-by-step/part2.rst
--- a/doc/source/admin/appdev-guide/step-by-step/part3.rst
+++ b/doc/source/admin/appdev-guide/step-by-step/part3.rst
--- a/doc/source/admin/appdev-guide/step-by-step/part4.rst
+++ b/doc/source/admin/appdev-guide/step-by-step/part4.rst
--- a/doc/source/admin/appdev-guide/step-by-step/plone-admin.png
+++ b/doc/source/admin/appdev-guide/step-by-step/plone-admin.png
--- a/doc/source/admin/appdev-guide/step-by-step/plone-logo.png
+++ b/doc/source/admin/appdev-guide/step-by-step/plone-logo.png
--- a/doc/source/admin/appdev-guide/step-by-step/plone-ready.png
+++ b/doc/source/admin/appdev-guide/step-by-step/plone-ready.png
--- a/doc/source/admin/appdev-guide/step-by-step/plone-simple-step1.png
+++ b/doc/source/admin/appdev-guide/step-by-step/plone-simple-step1.png
--- a/doc/source/admin/appdev-guide/step-by-step/plone-simple-step2.png
+++ b/doc/source/admin/appdev-guide/step-by-step/plone-simple-step2.png
--- a/doc/source/admin/appdev-guide/step-by-step/step_by_step.rst
+++ b/doc/source/admin/appdev-guide/step-by-step/step_by_step.rst
--- a/doc/source/admin/appdev-guide/use_cases.rst
+++ b/doc/source/admin/appdev-guide/use_cases.rst
--- a/doc/source/administrator-guide/configuration.rst
+++ b/doc/source/administrator-guide/configuration.rst
--- a/doc/source/administrator-guide/configure_cloud_foundry_service_broker.rst
+++ b/doc/source/administrator-guide/configure_cloud_foundry_service_broker.rst
--- a/doc/source/administrator-guide/deploy_murano.rst
+++ b/doc/source/administrator-guide/deploy_murano.rst
@ -1,5 +1,3 @@
-.. _install:
-
 ================
 Deploying murano
 ================
@ -10,4 +8,4 @@ Deploying murano
   deploy_murano/prerequisites
   deploy_murano/devstack
   deploy_murano/install_manually
-   deploy_murano/configure_ssl
+   deploy_murano/configure_ssl
--- a/doc/source/administrator-guide/deploy_murano/configure_ssl.rst
+++ b/doc/source/administrator-guide/deploy_murano/configure_ssl.rst
--- a/doc/source/administrator-guide/deploy_murano/devstack.rst
+++ b/doc/source/administrator-guide/deploy_murano/devstack.rst
--- a/doc/source/administrator-guide/deploy_murano/install_manually.rst
+++ b/doc/source/administrator-guide/deploy_murano/install_manually.rst
--- a/doc/source/administrator-guide/deploy_murano/prerequisites.rst
+++ b/doc/source/administrator-guide/deploy_murano/prerequisites.rst
--- a/doc/source/administrator-guide/figures/add-interface.png
+++ b/doc/source/administrator-guide/figures/add-interface.png
--- a/doc/source/administrator-guide/figures/deploy-log.png
+++ b/doc/source/administrator-guide/figures/deploy-log.png
--- a/doc/source/administrator-guide/figures/network-topology-1.png
+++ b/doc/source/administrator-guide/figures/network-topology-1.png
--- a/doc/source/administrator-guide/figures/network-topology-2.png
+++ b/doc/source/administrator-guide/figures/network-topology-2.png
--- a/doc/source/administrator-guide/figures/new-inst.png
+++ b/doc/source/administrator-guide/figures/new-inst.png
--- a/doc/source/administrator-guide/manage_categories.rst
+++ b/doc/source/administrator-guide/manage_categories.rst
--- a/doc/source/administrator-guide/manage_images.rst
+++ b/doc/source/administrator-guide/manage_images.rst
--- a/doc/source/administrator-guide/manage_packages.rst
+++ b/doc/source/administrator-guide/manage_packages.rst
--- a/doc/source/administrator-guide/murano_agent.rst
+++ b/doc/source/administrator-guide/murano_agent.rst
--- a/doc/source/administrator-guide/murano_repository.rst
+++ b/doc/source/administrator-guide/murano_repository.rst
--- a/doc/source/administrator-guide/policy_enf.rst
+++ b/doc/source/administrator-guide/policy_enf.rst
--- a/doc/source/administrator-guide/policy_enforcement/policy_enf_dev.rst
+++ b/doc/source/administrator-guide/policy_enforcement/policy_enf_dev.rst
--- a/doc/source/administrator-guide/policy_enforcement/policy_enf_modify.rst
+++ b/doc/source/administrator-guide/policy_enforcement/policy_enf_modify.rst
--- a/doc/source/administrator-guide/policy_enforcement/policy_enf_rules.rst
+++ b/doc/source/administrator-guide/policy_enforcement/policy_enf_rules.rst
--- a/doc/source/administrator-guide/policy_enforcement/policy_enf_setup.rst
+++ b/doc/source/administrator-guide/policy_enforcement/policy_enf_setup.rst
--- a/doc/source/administrator-guide/prepare_lab.rst
+++ b/doc/source/administrator-guide/prepare_lab.rst
--- a/doc/source/administrator-guide/using_glare.rst
+++ b/doc/source/administrator-guide/using_glare.rst
--- a/doc/source/appendix/articles/contributing.rst
+++ b/doc/source/appendix/articles/contributing.rst
@ -1 +0,0 @@
-.. include:: ../../../../CONTRIBUTING.rst
--- a/doc/source/contributor-guide/contributor_index.rst
+++ b/doc/source/contributor-guide/contributor_index.rst
--- a/doc/source/contributor-guide/dev_env.rst
+++ b/doc/source/contributor-guide/dev_env.rst
--- a/doc/source/contributor-guide/dev_guidelines.rst
+++ b/doc/source/contributor-guide/dev_guidelines.rst
--- a/doc/source/contributor-guide/doc_guidelines.rst
+++ b/doc/source/contributor-guide/doc_guidelines.rst
--- a/doc/source/contributor-guide/how_to_contribute.rst
+++ b/doc/source/contributor-guide/how_to_contribute.rst
--- a/doc/source/contributor-guide/plugins.rst
+++ b/doc/source/contributor-guide/plugins.rst
--- a/doc/source/contributor-guide/plugins/manage_plugins.rst
+++ b/doc/source/contributor-guide/plugins/manage_plugins.rst
--- a/doc/source/contributor-guide/plugins/murano_plugins.rst
+++ b/doc/source/contributor-guide/plugins/murano_plugins.rst
--- a/doc/source/contributor-guide/stable_branches.rst
+++ b/doc/source/contributor-guide/stable_branches.rst
--- a/doc/source/contributor-guide/testing.rst
+++ b/doc/source/contributor-guide/testing.rst
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -35,7 +35,7 @@ Introduction to Murano
 .. toctree::
   :maxdepth: 1

-   intro/overview_index
+   reference/overview_index


 Using Murano
@ -48,8 +48,16 @@ The screenshots provided in this guide are of the Liberty release.
 .. toctree::
   :maxdepth: 1

-   enduser-guide/quickstart/quickstart
-   enduser-guide/user_index
+   user/quickstart/quickstart
+   user/user_index
+
+Installation
+~~~~~~~~~~~~
+
+.. toctree::
+  :maxdepth: 2
+
+  install/index

 Administrator Documentation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -60,7 +68,7 @@ client.
 .. toctree::
   :maxdepth: 1

-   administrator-guide/admin_index
+   admin/admin_index

 First App Guide
 ~~~~~~~~~~~~~~~
@ -81,8 +89,8 @@ Murano.
 .. toctree::
   :maxdepth: 1

-   appdev-guide/developer_index
-   appdev-guide/faq
+   admin/appdev-guide/developer_index
+   admin/appdev-guide/faq

 Contributor Documentation
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@ -92,7 +100,7 @@ Learn how to contribute to the project.
 .. toctree::
   :maxdepth: 1

-   contributor-guide/contributor_index
+   contributor/contributor_index

 Other Documentation
 ~~~~~~~~~~~~~~~~~~~
@ -100,5 +108,5 @@ Other Documentation
 .. toctree::
   :maxdepth: 1

-   appendix/appendix_index
-   appendix/articles/articles_index
+   reference/appendix/appendix_index
+   reference/appendix/articles/articles_index
--- a/install-guide/source/common_prerequisites.rst
+++ b/install-guide/source/common_prerequisites.rst
--- a/install-guide/source/enable-ssl.rst
+++ b/install-guide/source/enable-ssl.rst
--- a/install-guide/source/get_started.rst
+++ b/install-guide/source/get_started.rst
--- a/install-guide/source/import-murano-apps.rst
+++ b/install-guide/source/import-murano-apps.rst
--- a/install-guide/source/index.rst
+++ b/install-guide/source/index.rst
--- a/Show More
+++ b/Show More