From 0e1a01a606ed2374574b5b30d9cea4e96084230b Mon Sep 17 00:00:00 2001 From: Ramprasad Velavarthipati Date: Fri, 23 Oct 2015 14:22:31 +0530 Subject: [PATCH] docs: reorganize docs for the sphinx build Reorganize docs into the appropriate folders for the new sphinx build. JIRA: VSPERF-80 Change-Id: I9dcd74e092ce52546a0986b92a1ebb2b5b7419bf Signed-off-by: Ramprasad Velavarthipati Signed-off-by: Maryam Tahhan Reviewed-by: Trinath Somanchi --- docs/design/index.rst | 27 +++++++++++++++++++ .../vswitchperf_design.rst | 6 ++--- docs/guides/index.rst | 28 +++++++++++++++++++ .../{to-be-reorganized => guides}/installation.rst | 0 docs/{to-be-reorganized => guides}/quickstart.rst | 2 +- .../images/TCLServerProperties.png | Bin docs/index.rst | 30 +++++++++++++++++++++ .../draft-vsperf-bmwg-vswitch-opnfv-00.xml | 0 .../draft-vsperf-bmwg-vswitch-opnfv-01.txt | 0 .../draft-vsperf-bmwg-vswitch-opnfv-01.xml | 0 docs/{to-be-reorganized => test_spec}/index.rst | 8 +++--- .../vswitchperf_ltd.rst | 20 +++++++------- docs/{to-be-reorganized => updates}/NEWS.rst | 0 docs/updates/index.rst | 27 +++++++++++++++++++ 14 files changed, 129 insertions(+), 19 deletions(-) create mode 100755 docs/design/index.rst rename docs/{to-be-reorganized => design}/vswitchperf_design.rst (98%) mode change 100644 => 100755 create mode 100755 docs/guides/index.rst rename docs/{to-be-reorganized => guides}/installation.rst (100%) mode change 100644 => 100755 rename docs/{to-be-reorganized => guides}/quickstart.rst (99%) mode change 100644 => 100755 rename docs/{to-be-reorganized => }/images/TCLServerProperties.png (100%) create mode 100755 docs/index.rst rename docs/{to-be-reorganized => test_spec}/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml (100%) rename docs/{to-be-reorganized => test_spec}/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.txt (100%) rename docs/{to-be-reorganized => test_spec}/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml (100%) rename docs/{to-be-reorganized => test_spec}/index.rst (87%) mode change 100644 => 100755 rename docs/{to-be-reorganized => test_spec}/vswitchperf_ltd.rst (99%) rename docs/{to-be-reorganized => updates}/NEWS.rst (100%) mode change 100644 => 100755 create mode 100755 docs/updates/index.rst diff --git a/docs/design/index.rst b/docs/design/index.rst new file mode 100755 index 00000000..f5d2cc5d --- /dev/null +++ b/docs/design/index.rst @@ -0,0 +1,27 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +VSPERF Design +======================================= + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + vswitchperf_design.rst + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/to-be-reorganized/vswitchperf_design.rst b/docs/design/vswitchperf_design.rst old mode 100644 new mode 100755 similarity index 98% rename from docs/to-be-reorganized/vswitchperf_design.rst rename to docs/design/vswitchperf_design.rst index 689c2098..d7fa67c3 --- a/docs/to-be-reorganized/vswitchperf_design.rst +++ b/docs/design/vswitchperf_design.rst @@ -38,7 +38,7 @@ Typical Test Sequence This is a typical flow of control for a test. -.. image:: images/vsperf.png +.. image:: ../images/vsperf.png Configuration @@ -156,7 +156,7 @@ Similarly the Traffic Controllers can be used to co-ordinate basic operations pr Traffic Controller's Role ------------------------- -.. image:: images/traffic_controller.png +.. image:: ../images/traffic_controller.png Loader & Component Factory @@ -164,7 +164,7 @@ Loader & Component Factory The working of the Loader package (which is responsible for *finding* arbitrary classes based on configuration data) and the Component Factory which is responsible for *choosing* the correct class for a particular situation - e.g. Deployment Scenario can be seen in this diagram. -.. image:: images/factory_and_loader.png +.. image:: ../images/factory_and_loader.png Routing Tables ============== diff --git a/docs/guides/index.rst b/docs/guides/index.rst new file mode 100755 index 00000000..c2b197d2 --- /dev/null +++ b/docs/guides/index.rst @@ -0,0 +1,28 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +VSPERF Guides and Installation +======================================== + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + quickstart.rst + installation.rst + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/to-be-reorganized/installation.rst b/docs/guides/installation.rst old mode 100644 new mode 100755 similarity index 100% rename from docs/to-be-reorganized/installation.rst rename to docs/guides/installation.rst diff --git a/docs/to-be-reorganized/quickstart.rst b/docs/guides/quickstart.rst old mode 100644 new mode 100755 similarity index 99% rename from docs/to-be-reorganized/quickstart.rst rename to docs/guides/quickstart.rst index 2a071d4f..630da7da --- a/docs/to-be-reorganized/quickstart.rst +++ b/docs/guides/quickstart.rst @@ -333,4 +333,4 @@ an appropriate amount of memory: -------------- -.. |Alt text| image:: images/TCLServerProperties.png +.. |Alt text| image:: ../images/TCLServerProperties.png diff --git a/docs/to-be-reorganized/images/TCLServerProperties.png b/docs/images/TCLServerProperties.png similarity index 100% rename from docs/to-be-reorganized/images/TCLServerProperties.png rename to docs/images/TCLServerProperties.png diff --git a/docs/index.rst b/docs/index.rst new file mode 100755 index 00000000..bb0a6988 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,30 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +VSPERF +======================================= + +Contents: + +.. toctree:: + :maxdepth: 4 + :titlesonly: + + guides/index + design/index + test_spec/index + updates/index + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/to-be-reorganized/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml b/docs/test_spec/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml similarity index 100% rename from docs/to-be-reorganized/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml rename to docs/test_spec/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml diff --git a/docs/to-be-reorganized/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.txt b/docs/test_spec/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.txt similarity index 100% rename from docs/to-be-reorganized/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.txt rename to docs/test_spec/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.txt diff --git a/docs/to-be-reorganized/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml b/docs/test_spec/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml similarity index 100% rename from docs/to-be-reorganized/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml rename to docs/test_spec/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml diff --git a/docs/to-be-reorganized/index.rst b/docs/test_spec/index.rst old mode 100644 new mode 100755 similarity index 87% rename from docs/to-be-reorganized/index.rst rename to docs/test_spec/index.rst index 1594d741..1ae1669a --- a/docs/to-be-reorganized/index.rst +++ b/docs/test_spec/index.rst @@ -9,7 +9,7 @@ :alt: OPNFV :align: left -Example Documentation table of contents +VSPERF Test Specification ======================================= Contents: @@ -19,12 +19,10 @@ Contents: :maxdepth: 4 quickstart.rst + installation.rst NEWS.rst vswitchperf_ltd.rst - installation.rst - -Indices and tables -================== + vswitchperf_design.rst * :ref:`search` diff --git a/docs/to-be-reorganized/vswitchperf_ltd.rst b/docs/test_spec/vswitchperf_ltd.rst similarity index 99% rename from docs/to-be-reorganized/vswitchperf_ltd.rst rename to docs/test_spec/vswitchperf_ltd.rst index 15c1de5c..5a7a7f2b 100755 --- a/docs/to-be-reorganized/vswitchperf_ltd.rst +++ b/docs/test_spec/vswitchperf_ltd.rst @@ -96,22 +96,22 @@ includes measuring the following performance metrics: meaning to different groups of people. In this document we will simply use the term packet delay variation. The preferred form for this metric is the PDV form of delay variation defined in `RFC5481 - `__. The most relevant + `__. The most relevant measurement of PDV considers the delay variation of a single user flow, as this will be relevant to the size of end-system buffers to compensate - for delay variation. The measurement system's ability to store the - delays of individual packets in the flow of interest is a key factor - that determines the specific measurement method. At the outset, it is + for delay variation. The measurement system's ability to store the + delays of individual packets in the flow of interest is a key factor + that determines the specific measurement method. At the outset, it is ideal to view the complete PDV distribution. Systems that can capture - and store packets and their delays have the freedom to calculate the + and store packets and their delays have the freedom to calculate the reference minimum delay and to determine various quantiles of the PDV - distribution accurately (in post-measurement processing routines). + distribution accurately (in post-measurement processing routines). Systems without storage must apply algorithms to calculate delay and - statistical measurements on the fly. For example, a system may store - temporary estimates of the mimimum delay and the set of (100) packets + statistical measurements on the fly. For example, a system may store + temporary estimates of the mimimum delay and the set of (100) packets with the longest delays during measurement (to calculate a high quantile, - and update these sets with new values periodically. - In some cases, a limited number of delay histogram bins will be + and update these sets with new values periodically. + In some cases, a limited number of delay histogram bins will be available, and the bin limits will need to be set using results from repeated experiments. See section 8 of `RFC5481 `__. diff --git a/docs/to-be-reorganized/NEWS.rst b/docs/updates/NEWS.rst old mode 100644 new mode 100755 similarity index 100% rename from docs/to-be-reorganized/NEWS.rst rename to docs/updates/NEWS.rst diff --git a/docs/updates/index.rst b/docs/updates/index.rst new file mode 100755 index 00000000..9d1e47e0 --- /dev/null +++ b/docs/updates/index.rst @@ -0,0 +1,27 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +VSPERF News +======================================= + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + NEWS.rst + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| -- 2.16.6