From ab6a95fe96f3c95e331f24b4f05092b8f28acc8d Mon Sep 17 00:00:00 2001 From: Juan Antonio Osorio Robles Date: Thu, 29 Nov 2018 16:15:12 +0200 Subject: [PATCH] Move developer documentation to top level It's harder to find as part of the install guide, and shouldn't be there anyway. Related-Bug: #1804642 Change-Id: Ia677ced783da6383211fb0bb7a28ec5fb2f538fe --- .../developer/developer.rst => developer/index.rst} | 0 .../developer/mistral_workflows/00-index.rst | 0 .../developer/mistral_workflows/01-introduction.rst | 0 .../developer/mistral_workflows/02-undercloud-backups.rst | 0 .../mistral_workflows/03-creating-new-cli-option.rst | 0 .../mistral_workflows/04-creating-mistral-workflows.rst | 0 .../05-tripleo-environment-variables.rst | 0 .../developer/mistral_workflows/06-test-local-changes.rst | 0 .../07-give-elevated-privileges-to-Mistral-actions.rst | 0 .../developer/mistral_workflows/08-debugging-actions.rst | 0 .../developer/mistral_workflows/09-unit-tests.rst | 0 .../developer/mistral_workflows/10-summary.rst | 0 doc/source/{install => }/developer/release.rst | 0 .../developer/tht_walkthrough/changes-puppet-tripleo.rst | 0 .../developer/tht_walkthrough/changes-tht.rst | 0 .../developer/tht_walkthrough/design-patterns.rst | 0 .../developer/tht_walkthrough/introduction.rst | 0 .../{install => }/developer/tht_walkthrough/summary.rst | 0 .../developer/tht_walkthrough/tht_walkthrough.rst | 0 .../developer/tht_walkthrough/tls_for_services.rst | 4 ++-- doc/source/index.rst | 8 ++++++++ doc/source/install/index.rst | 1 - doc/source/{install => }/links.rst | 0 23 files changed, 10 insertions(+), 3 deletions(-) rename doc/source/{install/developer/developer.rst => developer/index.rst} (100%) rename doc/source/{install => }/developer/mistral_workflows/00-index.rst (100%) rename doc/source/{install => }/developer/mistral_workflows/01-introduction.rst (100%) rename doc/source/{install => }/developer/mistral_workflows/02-undercloud-backups.rst (100%) rename doc/source/{install => }/developer/mistral_workflows/03-creating-new-cli-option.rst (100%) rename doc/source/{install => }/developer/mistral_workflows/04-creating-mistral-workflows.rst (100%) rename doc/source/{install => }/developer/mistral_workflows/05-tripleo-environment-variables.rst (100%) rename doc/source/{install => }/developer/mistral_workflows/06-test-local-changes.rst (100%) rename doc/source/{install => }/developer/mistral_workflows/07-give-elevated-privileges-to-Mistral-actions.rst (100%) rename doc/source/{install => }/developer/mistral_workflows/08-debugging-actions.rst (100%) rename doc/source/{install => }/developer/mistral_workflows/09-unit-tests.rst (100%) rename doc/source/{install => }/developer/mistral_workflows/10-summary.rst (100%) rename doc/source/{install => }/developer/release.rst (100%) rename doc/source/{install => }/developer/tht_walkthrough/changes-puppet-tripleo.rst (100%) rename doc/source/{install => }/developer/tht_walkthrough/changes-tht.rst (100%) rename doc/source/{install => }/developer/tht_walkthrough/design-patterns.rst (100%) rename doc/source/{install => }/developer/tht_walkthrough/introduction.rst (100%) rename doc/source/{install => }/developer/tht_walkthrough/summary.rst (100%) rename doc/source/{install => }/developer/tht_walkthrough/tht_walkthrough.rst (100%) rename doc/source/{install => }/developer/tht_walkthrough/tls_for_services.rst (99%) rename doc/source/{install => }/links.rst (100%) diff --git a/doc/source/install/developer/developer.rst b/doc/source/developer/index.rst similarity index 100% rename from doc/source/install/developer/developer.rst rename to doc/source/developer/index.rst diff --git a/doc/source/install/developer/mistral_workflows/00-index.rst b/doc/source/developer/mistral_workflows/00-index.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/00-index.rst rename to doc/source/developer/mistral_workflows/00-index.rst diff --git a/doc/source/install/developer/mistral_workflows/01-introduction.rst b/doc/source/developer/mistral_workflows/01-introduction.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/01-introduction.rst rename to doc/source/developer/mistral_workflows/01-introduction.rst diff --git a/doc/source/install/developer/mistral_workflows/02-undercloud-backups.rst b/doc/source/developer/mistral_workflows/02-undercloud-backups.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/02-undercloud-backups.rst rename to doc/source/developer/mistral_workflows/02-undercloud-backups.rst diff --git a/doc/source/install/developer/mistral_workflows/03-creating-new-cli-option.rst b/doc/source/developer/mistral_workflows/03-creating-new-cli-option.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/03-creating-new-cli-option.rst rename to doc/source/developer/mistral_workflows/03-creating-new-cli-option.rst diff --git a/doc/source/install/developer/mistral_workflows/04-creating-mistral-workflows.rst b/doc/source/developer/mistral_workflows/04-creating-mistral-workflows.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/04-creating-mistral-workflows.rst rename to doc/source/developer/mistral_workflows/04-creating-mistral-workflows.rst diff --git a/doc/source/install/developer/mistral_workflows/05-tripleo-environment-variables.rst b/doc/source/developer/mistral_workflows/05-tripleo-environment-variables.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/05-tripleo-environment-variables.rst rename to doc/source/developer/mistral_workflows/05-tripleo-environment-variables.rst diff --git a/doc/source/install/developer/mistral_workflows/06-test-local-changes.rst b/doc/source/developer/mistral_workflows/06-test-local-changes.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/06-test-local-changes.rst rename to doc/source/developer/mistral_workflows/06-test-local-changes.rst diff --git a/doc/source/install/developer/mistral_workflows/07-give-elevated-privileges-to-Mistral-actions.rst b/doc/source/developer/mistral_workflows/07-give-elevated-privileges-to-Mistral-actions.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/07-give-elevated-privileges-to-Mistral-actions.rst rename to doc/source/developer/mistral_workflows/07-give-elevated-privileges-to-Mistral-actions.rst diff --git a/doc/source/install/developer/mistral_workflows/08-debugging-actions.rst b/doc/source/developer/mistral_workflows/08-debugging-actions.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/08-debugging-actions.rst rename to doc/source/developer/mistral_workflows/08-debugging-actions.rst diff --git a/doc/source/install/developer/mistral_workflows/09-unit-tests.rst b/doc/source/developer/mistral_workflows/09-unit-tests.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/09-unit-tests.rst rename to doc/source/developer/mistral_workflows/09-unit-tests.rst diff --git a/doc/source/install/developer/mistral_workflows/10-summary.rst b/doc/source/developer/mistral_workflows/10-summary.rst similarity index 100% rename from doc/source/install/developer/mistral_workflows/10-summary.rst rename to doc/source/developer/mistral_workflows/10-summary.rst diff --git a/doc/source/install/developer/release.rst b/doc/source/developer/release.rst similarity index 100% rename from doc/source/install/developer/release.rst rename to doc/source/developer/release.rst diff --git a/doc/source/install/developer/tht_walkthrough/changes-puppet-tripleo.rst b/doc/source/developer/tht_walkthrough/changes-puppet-tripleo.rst similarity index 100% rename from doc/source/install/developer/tht_walkthrough/changes-puppet-tripleo.rst rename to doc/source/developer/tht_walkthrough/changes-puppet-tripleo.rst diff --git a/doc/source/install/developer/tht_walkthrough/changes-tht.rst b/doc/source/developer/tht_walkthrough/changes-tht.rst similarity index 100% rename from doc/source/install/developer/tht_walkthrough/changes-tht.rst rename to doc/source/developer/tht_walkthrough/changes-tht.rst diff --git a/doc/source/install/developer/tht_walkthrough/design-patterns.rst b/doc/source/developer/tht_walkthrough/design-patterns.rst similarity index 100% rename from doc/source/install/developer/tht_walkthrough/design-patterns.rst rename to doc/source/developer/tht_walkthrough/design-patterns.rst diff --git a/doc/source/install/developer/tht_walkthrough/introduction.rst b/doc/source/developer/tht_walkthrough/introduction.rst similarity index 100% rename from doc/source/install/developer/tht_walkthrough/introduction.rst rename to doc/source/developer/tht_walkthrough/introduction.rst diff --git a/doc/source/install/developer/tht_walkthrough/summary.rst b/doc/source/developer/tht_walkthrough/summary.rst similarity index 100% rename from doc/source/install/developer/tht_walkthrough/summary.rst rename to doc/source/developer/tht_walkthrough/summary.rst diff --git a/doc/source/install/developer/tht_walkthrough/tht_walkthrough.rst b/doc/source/developer/tht_walkthrough/tht_walkthrough.rst similarity index 100% rename from doc/source/install/developer/tht_walkthrough/tht_walkthrough.rst rename to doc/source/developer/tht_walkthrough/tht_walkthrough.rst diff --git a/doc/source/install/developer/tht_walkthrough/tls_for_services.rst b/doc/source/developer/tht_walkthrough/tls_for_services.rst similarity index 99% rename from doc/source/install/developer/tht_walkthrough/tls_for_services.rst rename to doc/source/developer/tht_walkthrough/tls_for_services.rst index 17c07843..8e9b39b1 100644 --- a/doc/source/install/developer/tht_walkthrough/tls_for_services.rst +++ b/doc/source/developer/tht_walkthrough/tls_for_services.rst @@ -224,7 +224,7 @@ Internal TLS How it works ~~~~~~~~~~~~ -If you haven't read the section :doc:`../../advanced_deployment/tls_everywhere` +If you haven't read the section :doc:`../../install/advanced_deployment/tls_everywhere` it is highly recommended you read that first before continuing. As mentioned, the default CA is FreeIPA, which issues the certificates that the @@ -387,7 +387,7 @@ template. This section will be in the same level as ``config_settings`` and Note that it merely outputs the metadata_settings section that the apache base stack already outputs. This will give the appropriate parameters to a hook that sets the nova metadata, which in turn will be taken by the *novajoin* service -(which was mentioned in the :doc:`../../advanced_deployment/tls_everywhere` +(which was mentioned in the :doc:`../../install/advanced_deployment/tls_everywhere` section) to generate the service principals for httpd for the host. .. _configuring-haproxy-internal-tls: diff --git a/doc/source/index.rst b/doc/source/index.rst index 599d34de..07290637 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -34,6 +34,14 @@ Upgrades/Updates/FFWD-Upgrade upgrade/index +Developer Guide +--------------- + +.. toctree:: + :maxdepth: 3 + :includehidden: + + developer/index Documentation Conventions ========================= diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index ee5596ab..96bb46b9 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -23,4 +23,3 @@ TripleO Install Guide troubleshooting/troubleshooting validations/validations mistral-api/mistral-api - developer/developer diff --git a/doc/source/install/links.rst b/doc/source/links.rst similarity index 100% rename from doc/source/install/links.rst rename to doc/source/links.rst