Make main docs page more readable

* Edit index.rst to dynamically import sub-pages * Rename results folders to be similar to test plans folders * Rename results headers to be similar to test plans headers Co-Authored-By: David Burnazyan <dburnazyan@mirantis.com> Closes-Bug: #1609923 Change-Id: I7d0d9a534c931a85ea7b074cee5429d1175f038b
2016-08-08 14:09:05 -07:00 · 2016-08-08 14:09:05 -07:00 · f021bc9953
commit f021bc9953
parent e1836fe287
52 changed files with 33 additions and 49 deletions
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -19,9 +19,9 @@ Contents
    :maxdepth: 2

    introduction.rst
-    methodologies/index.rst
-    test_plans/index.rst
+    methodologies/index
    labs/index.rst
+    test_plans/index
    test_results/index

 .. raw:: pdf
--- a/doc/source/test_plans/controlplane_density/plan.rst
+++ b/doc/source/test_plans/controlplane_density/plan.rst
@ -1,7 +1,7 @@
 .. _controlplane_density:

 =======================================
-OpenStack Control Plane Density testing
+OpenStack control plane density testing
 =======================================

 :status: **ready**
--- a/doc/source/test_plans/hardware_features/hardware_offloads/test_plan.rst
+++ b/doc/source/test_plans/hardware_features/hardware_offloads/test_plan.rst
--- a/doc/source/test_plans/hardware_features/index.rst
+++ b/doc/source/test_plans/hardware_features/index.rst
@ -9,4 +9,4 @@ Hardware features test plans
 .. toctree::
    :maxdepth: 3

-    hardware_offloads/test_plan
+    hardware_offloads/plan
--- a/doc/source/test_plans/index.rst
+++ b/doc/source/test_plans/index.rst
@ -2,25 +2,12 @@

    PageBreak oneColumn

-=======================
+==========
 Test Plans
-=======================
+==========

 .. toctree::
-    :maxdepth: 2
+    :glob:

-    mq/plan
-    mq_ha/plan
-    db/plan
-    provisioning/plan
-    tenant_networking/plan
-    container_repositories/plan
-    keystone/plan
-    container_cluster_systems/plan
-    neutron_features/l3_ha/test_plan
-    hardware_features/index
-    openstack_load/plan
-    1000_nodes/plan
-    reliability/plan
-    control_plane/plan
-    controlplane_density/plan
+    */plan
+    */index
--- a/doc/source/test_plans/neutron_features/index.rst
+++ b/doc/source/test_plans/neutron_features/index.rst
@ -0,0 +1,12 @@
+.. raw:: pdf
+
+    PageBreak oneColumn
+
+===========================
+Neutron features test plans
+===========================
+
+.. toctree::
+    :maxdepth: 3
+
+    l3_ha/plan
--- a/doc/source/test_plans/neutron_features/l3_ha/test_plan.rst
+++ b/doc/source/test_plans/neutron_features/l3_ha/test_plan.rst
--- a/doc/source/test_plans/tenant_networking/plan.rst
+++ b/doc/source/test_plans/tenant_networking/plan.rst
@ -1,8 +1,8 @@
 .. _openstack_tenant_networking_test_plan:

-=====================================
-OpenStack Tenant Networking Test Plan
-=====================================
+=======================================
+OpenStack tenant networking performance
+=======================================

 :status: **draft**
 :version: 1.0
--- a/doc/source/test_results/1000_nodes/index.rst
+++ b/doc/source/test_results/1000_nodes/index.rst
@ -1,5 +1,5 @@
-Testing on scale of 1000 compute hosts.
-=======================================
+1000 Compute nodes resource scalability testing
+===============================================

 Environment setup
 -----------------
--- a/doc/source/test_results/container_cluster_systems/index.rst
+++ b/doc/source/test_results/container_cluster_systems/index.rst
@ -1,5 +1,5 @@
-Container platforms test results
-********************************
+Container cluster systems performance
+*************************************

 .. toctree::
    :numbered:
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/Network_Scheme.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/Network_Scheme.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/create-1.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/create-1.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/create-16.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/create-16.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/create-2.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/create-2.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/create-4.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/create-4.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/create-8.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/create-8.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/delete-1.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/delete-1.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/delete-16.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/delete-16.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/delete-2.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/delete-2.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/delete-4.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/delete-4.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/delete-8.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/delete-8.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/mesos-marathon.rst
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/mesos-marathon.rst
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/restart-16.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/restart-16.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/restart-2.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/restart-2.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/restart-4.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/restart-4.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/restart-8.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/restart-8.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/results-marathon-health-check.rst
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/results-marathon-health-check.rst
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/results-mesos-marathon.rst
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/results-mesos-marathon.rst
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_cpu-1.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_cpu-1.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_cpu-16.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_cpu-16.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_cpu-2.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_cpu-2.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_cpu-4.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_cpu-4.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_cpu-8.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_cpu-8.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_disk-1.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_disk-1.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_disk-16.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_disk-16.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_disk-2.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_disk-2.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_disk-4.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_disk-4.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_disk-8.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_disk-8.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_instances-1.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_instances-1.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_instances-16.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_instances-16.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_instances-2.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_instances-2.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_instances-4.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_instances-4.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_instances-8.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_instances-8.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_mem-1.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_mem-1.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_mem-16.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_mem-16.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_mem-2.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_mem-2.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_mem-4.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_mem-4.png
--- a/doc/source/test_results/container_cluster_systems/mesos-marathon/update_mem-8.png
+++ b/doc/source/test_results/container_cluster_systems/mesos-marathon/update_mem-8.png
--- a/doc/source/test_results/container_repositories/index.rst
+++ b/doc/source/test_results/container_repositories/index.rst
@ -1,5 +1,5 @@
-Container repositories test results
-***********************************
+Container repositories performance
+**********************************

 .. toctree::
    :numbered:
--- a/doc/source/test_results/control_plane/index.rst
+++ b/doc/source/test_results/control_plane/index.rst
--- a/doc/source/test_results/index.rst
+++ b/doc/source/test_results/index.rst
@ -7,21 +7,6 @@ Test Results
 ============

 .. toctree::
-    :maxdepth: 2
+    :glob:

-    mq/index
-    mq_ha/index
-    container_repositories/index
-    db/index
-    tenant_networking/index
-    keystone/index
-    container_platforms/index
-    neutron_features/index
-    hardware_features/index
-    provisioning/index
-    openstack_load/index
-    1000_nodes/index
-    reliability/index
-    control_plane/main
-    controlplane_density/index
-    monitoring/index
+    */index
--- a/doc/source/test_results/tenant_networking/index.rst
+++ b/doc/source/test_results/tenant_networking/index.rst
@ -3,7 +3,7 @@
    PageBreak oneColumn

 ===========================
-OpenStack Tenant Networking
+OpenStack tenant networking
 ===========================

 .. toctree::