From 0859794433b712f5dcc029a6506c5d7abfecce6d Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Thu, 29 Jun 2017 16:21:38 -0400 Subject: [PATCH] rearrange existing docs to fit the new standard layout Refer to https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html for details. Change-Id: Icd7cca752c8b87eb4543f0307bbf6e7ae07194b5 Signed-off-by: Doug Hellmann --- .../{dev => admin}/building_guest_images.rst | 0 .../{dev => admin}/guest_cloud_init.rst | 0 doc/source/admin/index.rst | 10 ++ .../{dev => admin}/secure_oslo_messaging.rst | 0 doc/source/{dev => contributor}/design.rst | 0 .../how_to_create_a_trove_instance.rst | 0 doc/source/contributor/index.rst | 14 +++ doc/source/{dev => contributor}/testing.rst | 0 doc/source/dev/install.rst | 93 ------------------- doc/source/index.rst | 43 ++------- .../{deploy => install}/apache-mod-wsgi.rst | 0 .../source/install}/common_configure.txt | 0 .../source/install}/common_prerequisites.txt | 0 .../source => doc/source/install}/conf.py | 0 .../source/install}/dashboard.rst | 0 .../source/install}/get_started.rst | 0 .../source => doc/source/install}/index.rst | 5 + .../source/install}/install-obs.rst | 0 .../source/install}/install-rdo.rst | 0 .../source/install}/install-ubuntu.rst | 0 .../source => doc/source/install}/install.rst | 0 .../{dev => install}/manual_install.rst | 0 .../source/install}/next-steps.rst | 0 .../source => doc/source/install}/verify.rst | 0 doc/source/reference/index.rst | 9 ++ doc/source/{dev => reference}/notifier.rst | 0 .../trove_api_extensions.rst | 0 27 files changed, 45 insertions(+), 129 deletions(-) rename doc/source/{dev => admin}/building_guest_images.rst (100%) rename doc/source/{dev => admin}/guest_cloud_init.rst (100%) create mode 100644 doc/source/admin/index.rst rename doc/source/{dev => admin}/secure_oslo_messaging.rst (100%) rename doc/source/{dev => contributor}/design.rst (100%) rename doc/source/{dev => contributor}/how_to_create_a_trove_instance.rst (100%) create mode 100644 doc/source/contributor/index.rst rename doc/source/{dev => contributor}/testing.rst (100%) delete mode 100644 doc/source/dev/install.rst rename doc/source/{deploy => install}/apache-mod-wsgi.rst (100%) rename {install-guide/source => doc/source/install}/common_configure.txt (100%) rename {install-guide/source => doc/source/install}/common_prerequisites.txt (100%) rename {install-guide/source => doc/source/install}/conf.py (100%) rename {install-guide/source => doc/source/install}/dashboard.rst (100%) rename {install-guide/source => doc/source/install}/get_started.rst (100%) rename {install-guide/source => doc/source/install}/index.rst (78%) rename {install-guide/source => doc/source/install}/install-obs.rst (100%) rename {install-guide/source => doc/source/install}/install-rdo.rst (100%) rename {install-guide/source => doc/source/install}/install-ubuntu.rst (100%) rename {install-guide/source => doc/source/install}/install.rst (100%) rename doc/source/{dev => install}/manual_install.rst (100%) rename {install-guide/source => doc/source/install}/next-steps.rst (100%) rename {install-guide/source => doc/source/install}/verify.rst (100%) create mode 100644 doc/source/reference/index.rst rename doc/source/{dev => reference}/notifier.rst (100%) rename doc/source/{dev => reference}/trove_api_extensions.rst (100%) diff --git a/doc/source/dev/building_guest_images.rst b/doc/source/admin/building_guest_images.rst similarity index 100% rename from doc/source/dev/building_guest_images.rst rename to doc/source/admin/building_guest_images.rst diff --git a/doc/source/dev/guest_cloud_init.rst b/doc/source/admin/guest_cloud_init.rst similarity index 100% rename from doc/source/dev/guest_cloud_init.rst rename to doc/source/admin/guest_cloud_init.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst new file mode 100644 index 0000000000..344bfc4555 --- /dev/null +++ b/doc/source/admin/index.rst @@ -0,0 +1,10 @@ +======================= + Administrator's Guide +======================= + +.. toctree:: + :maxdepth: 2 + + building_guest_images.rst + guest_cloud_init.rst + secure_oslo_messaging.rst diff --git a/doc/source/dev/secure_oslo_messaging.rst b/doc/source/admin/secure_oslo_messaging.rst similarity index 100% rename from doc/source/dev/secure_oslo_messaging.rst rename to doc/source/admin/secure_oslo_messaging.rst diff --git a/doc/source/dev/design.rst b/doc/source/contributor/design.rst similarity index 100% rename from doc/source/dev/design.rst rename to doc/source/contributor/design.rst diff --git a/doc/source/dev/how_to_create_a_trove_instance.rst b/doc/source/contributor/how_to_create_a_trove_instance.rst similarity index 100% rename from doc/source/dev/how_to_create_a_trove_instance.rst rename to doc/source/contributor/how_to_create_a_trove_instance.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000000..36f1cfc12d --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,14 @@ +======================= + Contributor Resources +======================= + +For those wishing to develop Trove itself, or to extend Trove's +functionality, the following resources are provided. + + +.. toctree:: + :maxdepth: 1 + + design + testing + how_to_create_a_trove_instance.rst diff --git a/doc/source/dev/testing.rst b/doc/source/contributor/testing.rst similarity index 100% rename from doc/source/dev/testing.rst rename to doc/source/contributor/testing.rst diff --git a/doc/source/dev/install.rst b/doc/source/dev/install.rst deleted file mode 100644 index f5dcd4f05e..0000000000 --- a/doc/source/dev/install.rst +++ /dev/null @@ -1,93 +0,0 @@ -.. _install: - -================== -Trove Installation -================== - -Trove is constantly under development. The easiest way to install -Trove is using the Trove integration scripts that can be found in -git in the `Trove Repository`_. - - -Steps to set up a Trove Developer Environment -============================================= - ----------------- -Installing trove ----------------- - -* Install a fresh Ubuntu 14.04 (Trusty Tahr) image (preferably a - virtual machine) - -* Make sure we have git installed:: - - # apt-get update - # apt-get install git -y - -* Add a user named ubuntu if you do not already have one:: - - # adduser ubuntu - -* Set the ubuntu user up with sudo access:: - - # visudo - - Add *ubuntu ALL=(ALL) NOPASSWD: ALL* to the sudoers file. - -* Login with ubuntu:: - - # su ubuntu - # mkdir -p /opt/stack - # cd /opt/stack - -* Clone this repo:: - - # git clone https://git.openstack.org/openstack/trove.git - -* cd into the scripts directory:: - - # cd trove/integration/scripts/ - -It is important to understand that this process is different now with -the elements and scripts being part of the trove repository. In the -past, one could clone trove-integration into the home directory and -run trovestack from there, and it would clone trove in the right -place. And if you were making changes in trove-integration, it didn't -really matter where trove-integration was; it could be in home -directory or /opt/stack, or for that matter, anywhere. This is no -longer the case. If you are making changes to trove and would like to -run the trovestack script, you have to be sure that trove is in fact -cloned in /opt/stack as shown above. - - ---------------------------------- -Running trovestack to setup Trove ---------------------------------- - -Now you run trovestack to help setup your development environment. For -complete details about the trovestack script refer to -trove/integration/README.md - ------------------------- -Running the trove client ------------------------- - -* The trove client is run using the trove command. You can show the - complete documentation on the shell by running trove help:: - - # trove help - - ------------------------ -Running the nova client ------------------------ - -* The nova client is run using the nova command. You can show the - complete documentation on the shell by running nova help::: - - # nova help - -References -========== - -.. _Trove Repository: https://git.openstack.org/cgit/openstack/trove diff --git a/doc/source/index.rst b/doc/source/index.rst index 4286bf7889..88189cdfea 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,9 +2,6 @@ Welcome to Trove's developer documentation! =========================================== -Introduction -============ - Trove is Database as a Service for OpenStack. It's designed to run entirely on OpenStack, with the goal of allowing users to quickly and easily utilize the features of a relational database without the @@ -18,42 +15,16 @@ including deployment, configuration, patching, backups, restores, and monitoring. For an in-depth look at the project's design and structure, see the -:doc:`dev/design` page. - - -Installation And Deployment -=========================== - -Trove is constantly under development. The easiest way to install -Trove is using the Trove integration scripts that can be found in -git in the `Trove`_ Repository. - -For further details on how to install Trove using the integration -scripts please refer to the :doc:`dev/install` page. - -For further details on how to install Trove to work with existing -OpenStack environment please refer to the :doc:`dev/manual_install` page. - -Developer Resources -=================== - -For those wishing to develop Trove itself, or to extend Trove's -functionality, the following resources are provided. +:doc:`contributor/design` page. .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + + install/index + admin/index + contributor/index + reference/index - dev/design - dev/testing - dev/install - dev/manual_install.rst - dev/building_guest_images.rst - dev/guest_cloud_init.rst - dev/notifier.rst - dev/trove_api_extensions.rst - dev/secure_oslo_messaging.rst - deploy/apache-mod-wsgi - dev/how_to_create_a_trove_instance.rst * Source Code Repositories diff --git a/doc/source/deploy/apache-mod-wsgi.rst b/doc/source/install/apache-mod-wsgi.rst similarity index 100% rename from doc/source/deploy/apache-mod-wsgi.rst rename to doc/source/install/apache-mod-wsgi.rst diff --git a/install-guide/source/common_configure.txt b/doc/source/install/common_configure.txt similarity index 100% rename from install-guide/source/common_configure.txt rename to doc/source/install/common_configure.txt diff --git a/install-guide/source/common_prerequisites.txt b/doc/source/install/common_prerequisites.txt similarity index 100% rename from install-guide/source/common_prerequisites.txt rename to doc/source/install/common_prerequisites.txt diff --git a/install-guide/source/conf.py b/doc/source/install/conf.py similarity index 100% rename from install-guide/source/conf.py rename to doc/source/install/conf.py diff --git a/install-guide/source/dashboard.rst b/doc/source/install/dashboard.rst similarity index 100% rename from install-guide/source/dashboard.rst rename to doc/source/install/dashboard.rst diff --git a/install-guide/source/get_started.rst b/doc/source/install/get_started.rst similarity index 100% rename from install-guide/source/get_started.rst rename to doc/source/install/get_started.rst diff --git a/install-guide/source/index.rst b/doc/source/install/index.rst similarity index 78% rename from install-guide/source/index.rst rename to doc/source/install/index.rst index a88d5ac41d..338d35f55c 100644 --- a/install-guide/source/index.rst +++ b/doc/source/install/index.rst @@ -4,8 +4,13 @@ Database service .. toctree:: + apache-mod-wsgi.rst get_started.rst install.rst + install-obs.rst + install-rdo.rst + install-ubuntu.rst + manual_install.rst dashboard.rst verify.rst next-steps.rst diff --git a/install-guide/source/install-obs.rst b/doc/source/install/install-obs.rst similarity index 100% rename from install-guide/source/install-obs.rst rename to doc/source/install/install-obs.rst diff --git a/install-guide/source/install-rdo.rst b/doc/source/install/install-rdo.rst similarity index 100% rename from install-guide/source/install-rdo.rst rename to doc/source/install/install-rdo.rst diff --git a/install-guide/source/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst similarity index 100% rename from install-guide/source/install-ubuntu.rst rename to doc/source/install/install-ubuntu.rst diff --git a/install-guide/source/install.rst b/doc/source/install/install.rst similarity index 100% rename from install-guide/source/install.rst rename to doc/source/install/install.rst diff --git a/doc/source/dev/manual_install.rst b/doc/source/install/manual_install.rst similarity index 100% rename from doc/source/dev/manual_install.rst rename to doc/source/install/manual_install.rst diff --git a/install-guide/source/next-steps.rst b/doc/source/install/next-steps.rst similarity index 100% rename from install-guide/source/next-steps.rst rename to doc/source/install/next-steps.rst diff --git a/install-guide/source/verify.rst b/doc/source/install/verify.rst similarity index 100% rename from install-guide/source/verify.rst rename to doc/source/install/verify.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000000..862b64e0b7 --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,9 @@ +================== + Reference Guides +================== + +.. toctree:: + :maxdepth: 1 + + notifier.rst + trove_api_extensions.rst diff --git a/doc/source/dev/notifier.rst b/doc/source/reference/notifier.rst similarity index 100% rename from doc/source/dev/notifier.rst rename to doc/source/reference/notifier.rst diff --git a/doc/source/dev/trove_api_extensions.rst b/doc/source/reference/trove_api_extensions.rst similarity index 100% rename from doc/source/dev/trove_api_extensions.rst rename to doc/source/reference/trove_api_extensions.rst