diff --git a/doc/source/image_src/architecture.dia b/doc/source/_static/images/architecture.dia similarity index 100% rename from doc/source/image_src/architecture.dia rename to doc/source/_static/images/architecture.dia diff --git a/doc/source/images/architecture.svg b/doc/source/_static/images/architecture.svg similarity index 100% rename from doc/source/images/architecture.svg rename to doc/source/_static/images/architecture.svg diff --git a/doc/source/image_src/create_vm_states.diag b/doc/source/_static/images/create-vm-states.dia similarity index 100% rename from doc/source/image_src/create_vm_states.diag rename to doc/source/_static/images/create-vm-states.dia diff --git a/doc/source/images/filteringWorkflow1.png b/doc/source/_static/images/filtering-workflow-1.png similarity index 100% rename from doc/source/images/filteringWorkflow1.png rename to doc/source/_static/images/filtering-workflow-1.png diff --git a/doc/source/images/filteringWorkflow2.png b/doc/source/_static/images/filtering-workflow-2.png similarity index 100% rename from doc/source/images/filteringWorkflow2.png rename to doc/source/_static/images/filtering-workflow-2.png diff --git a/doc/source/contributor/placement.rst b/doc/source/contributor/placement.rst index c30b7689b0..fb3a119e87 100644 --- a/doc/source/contributor/placement.rst +++ b/doc/source/contributor/placement.rst @@ -18,16 +18,17 @@ Overview ======== -The Nova project introduced the :doc:`placement service ` as part -of the Newton release. The service provides an HTTP API to manage inventories -of different classes of resources, such as disk or virtual cpus, made available -by entities called resource providers. Information provided through the -placement API is intended to enable more effective accounting of resources in -an OpenStack deployment and better scheduling of various entities in the cloud. +The Nova project introduced the :doc:`placement service ` as +part of the Newton release. The service provides an HTTP API to manage +inventories of different classes of resources, such as disk or virtual cpus, +made available by entities called resource providers. Information provided +through the placement API is intended to enable more effective accounting of +resources in an OpenStack deployment and better scheduling of various entities +in the cloud. The document serves to explain the architecture of the system and to provide some guidance on how to maintain and extend the code. For more detail on why -the system was created and how it does its job see :doc:`/placement`. +the system was created and how it does its job see :doc:`/user/placement`. Big Picture =========== @@ -132,8 +133,8 @@ Microversions ============= The placement API makes use of `microversions`_ to allow the release of new -features on an opt in basis. See :doc:`/placement` for an up to date history of -the available microversions. +features on an opt in basis. See :doc:`/user/placement` for an up to date +history of the available microversions. The rules around when a microversion is needed are the same as for the :doc:`compute API `. When adding a new microversion diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index c2180eed1c..1258a7df62 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -26,8 +26,8 @@ features working across upgrades, we must aim to test all features. Reporting Test Coverage ======================= -For details on plans to report the current test coverage, please see: -:doc:`/feature_classification` +For details on plans to report the current test coverage, refer to +:doc:`/user/feature-classification`. Running tests and reporting results =================================== diff --git a/doc/source/image_src/PowerStates.odp b/doc/source/image_src/PowerStates.odp deleted file mode 100644 index e6704b6b95..0000000000 Binary files a/doc/source/image_src/PowerStates.odp and /dev/null differ diff --git a/doc/source/index.rst b/doc/source/index.rst index 9c7b5d7baa..841de444c9 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -86,8 +86,8 @@ integration testing efforts. :maxdepth: 1 contributor/testing - feature_classification - support-matrix + user/feature-classification + user/support-matrix Developer Guide =============== @@ -100,7 +100,7 @@ actually does, and why. contributor/how-to-get-involved contributor/process - architecture + user/architecture contributor/project-scope contributor/development-environment @@ -148,18 +148,18 @@ Open Development. contributor/api-2 reference/rpc - block_device_mapping - conductor - filter_scheduler - aggregates + user/block-device-mapping + user/conductor + user/filter-scheduler + user/aggregates reference/i18n reference/notifications - placement + user/placement contributor/placement - quotas + user/quotas reference/threading reference/vm-states - wsgi + user/wsgi Architecture Evolution Plans ----------------------------- @@ -174,8 +174,8 @@ these are a great place to start reading up on the current plans. .. toctree:: :maxdepth: 1 - cells - upgrade + user/cells + user/upgrade contributor/api contributor/microversions reference/policy-enforcement @@ -238,7 +238,7 @@ Metadata .. toctree:: :maxdepth: 1 - vendordata + user/vendordata Indices and tables ================== diff --git a/doc/source/aggregates.rst b/doc/source/user/aggregates.rst similarity index 100% rename from doc/source/aggregates.rst rename to doc/source/user/aggregates.rst diff --git a/doc/source/architecture.rst b/doc/source/user/architecture.rst similarity index 98% rename from doc/source/architecture.rst rename to doc/source/user/architecture.rst index 3d0824ba2b..6e1e962c44 100644 --- a/doc/source/architecture.rst +++ b/doc/source/user/architecture.rst @@ -50,7 +50,7 @@ Components Below you will find a helpful explanation of the key components of a typical (non-cells v1) Nova deployment. -.. image:: ./images/architecture.svg +.. image:: /_static/images/architecture.svg :width: 100% * DB: sql database for data storage. diff --git a/doc/source/block_device_mapping.rst b/doc/source/user/block-device-mapping.rst similarity index 100% rename from doc/source/block_device_mapping.rst rename to doc/source/user/block-device-mapping.rst diff --git a/doc/source/cells.rst b/doc/source/user/cells.rst similarity index 100% rename from doc/source/cells.rst rename to doc/source/user/cells.rst diff --git a/doc/source/conductor.rst b/doc/source/user/conductor.rst similarity index 100% rename from doc/source/conductor.rst rename to doc/source/user/conductor.rst diff --git a/doc/source/feature_classification.rst b/doc/source/user/feature-classification.rst similarity index 97% rename from doc/source/feature_classification.rst rename to doc/source/user/feature-classification.rst index 784213fa49..ceeafe572f 100644 --- a/doc/source/feature_classification.rst +++ b/doc/source/user/feature-classification.rst @@ -52,7 +52,7 @@ Below there are sections on NFV and HPC specific features. These look at specific features and scenarios that are important to those more specific sets of use cases. -.. feature_matrix:: feature_matrix_gp.ini +.. feature_matrix:: feature-matrix-gp.ini .. _matrix-nfv: @@ -65,7 +65,7 @@ create a particular service. It is common for this workloads needing bare metal like performance, i.e. low latency and close to line speed performance. -.. feature_matrix:: feature_matrix_nfv.ini +.. feature_matrix:: feature-matrix-nfv.ini .. _matrix-hpc: @@ -75,7 +75,7 @@ HPC Cloud Features High Performance Compute (HPC) cloud have some specific needs that are covered in this set of features. -.. feature_matrix:: feature_matrix_hpc.ini +.. feature_matrix:: feature-matrix-hpc.ini .. _notes-on-concepts: diff --git a/doc/source/feature_matrix_gp.ini b/doc/source/user/feature-matrix-gp.ini similarity index 100% rename from doc/source/feature_matrix_gp.ini rename to doc/source/user/feature-matrix-gp.ini diff --git a/doc/source/feature_matrix_hpc.ini b/doc/source/user/feature-matrix-hpc.ini similarity index 100% rename from doc/source/feature_matrix_hpc.ini rename to doc/source/user/feature-matrix-hpc.ini diff --git a/doc/source/feature_matrix_nfv.ini b/doc/source/user/feature-matrix-nfv.ini similarity index 100% rename from doc/source/feature_matrix_nfv.ini rename to doc/source/user/feature-matrix-nfv.ini diff --git a/doc/source/filter_scheduler.rst b/doc/source/user/filter-scheduler.rst similarity index 99% rename from doc/source/filter_scheduler.rst rename to doc/source/user/filter-scheduler.rst index 70e34258c4..0e4fb4eb04 100644 --- a/doc/source/filter_scheduler.rst +++ b/doc/source/user/filter-scheduler.rst @@ -8,7 +8,7 @@ working with Compute Nodes only. Filtering --------- -.. image:: ./images/filteringWorkflow1.png +.. image:: /_static/images/filtering-workflow-1.png During its work Filter Scheduler iterates over all found compute nodes, evaluating each against a set of filters. The list of resulting hosts is @@ -470,7 +470,7 @@ so subsequent selections can adjust accordingly. It is useful if the customer asks for a large block of instances, because weight is computed for each instance requested. -.. image:: ./images/filteringWorkflow2.png +.. image:: /_static/images/filtering-workflow-2.png At the end Filter Scheduler sorts selected hosts by their weight and attempts to provision instances on the chosen hosts. diff --git a/doc/source/placement.rst b/doc/source/user/placement.rst similarity index 99% rename from doc/source/placement.rst rename to doc/source/user/placement.rst index b0cb0da283..ea47d2204d 100644 --- a/doc/source/placement.rst +++ b/doc/source/user/placement.rst @@ -227,4 +227,4 @@ nova-compute service could be Newton level code making requests to an Ocata placement API, and vice-versa, an Ocata compute service in a cells v2 cell could be making requests to a Newton placement API. -.. include:: ../../nova/api/openstack/placement/rest_api_version_history.rst +.. include:: ../../../nova/api/openstack/placement/rest_api_version_history.rst diff --git a/doc/source/quotas.rst b/doc/source/user/quotas.rst similarity index 100% rename from doc/source/quotas.rst rename to doc/source/user/quotas.rst diff --git a/doc/source/support-matrix.ini b/doc/source/user/support-matrix.ini similarity index 100% rename from doc/source/support-matrix.ini rename to doc/source/user/support-matrix.ini diff --git a/doc/source/support-matrix.rst b/doc/source/user/support-matrix.rst similarity index 97% rename from doc/source/support-matrix.rst rename to doc/source/user/support-matrix.rst index ccf9090f47..d3d6e9ff49 100644 --- a/doc/source/support-matrix.rst +++ b/doc/source/user/support-matrix.rst @@ -5,7 +5,7 @@ Feature Support Matrix .. warning:: Please note, while this document is still being maintained, this is slowly being updated to re-group and classify features using the definitions - described in here: :doc:`feature_classification` + described in here: :doc:`feature-classification` When considering which capabilities should be marked as mandatory the following general guiding principles were applied diff --git a/doc/source/upgrade.rst b/doc/source/user/upgrade.rst similarity index 100% rename from doc/source/upgrade.rst rename to doc/source/user/upgrade.rst diff --git a/doc/source/vendordata.rst b/doc/source/user/vendordata.rst similarity index 100% rename from doc/source/vendordata.rst rename to doc/source/user/vendordata.rst diff --git a/doc/source/wsgi.rst b/doc/source/user/wsgi.rst similarity index 100% rename from doc/source/wsgi.rst rename to doc/source/user/wsgi.rst