From: Julien Date: Thu, 17 Aug 2017 13:32:10 +0000 (+0800) Subject: restruct documents according to opnfvdocs X-Git-Tag: 6.0.0~106 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=aa88673c38be12368dead5e8241fb915d790c431;p=pharos.git restruct documents according to opnfvdocs Use only development and release for we don't have test codes for now. JIRA: PHAROS-311 Change-Id: Iacfcaba81a7a52e09cf999b8603cc9dc2f8f2b97 Signed-off-by: Julien --- diff --git a/docs/development/design/.keep b/docs/development/design/.keep new file mode 100644 index 00000000..e69de29b diff --git a/docs/development/overview/.keep b/docs/development/overview/.keep new file mode 100644 index 00000000..e69de29b diff --git a/docs/development/requirement/.keep b/docs/development/requirement/.keep new file mode 100644 index 00000000..e69de29b diff --git a/docs/index.rst b/docs/index.rst index 94844fa9..5777eede 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,14 +14,14 @@ OPNFV Community Lab Infrastructure ================================== .. toctree:: - :maxdepth: 3 - :numbered: 3 + :maxdepth: 5 + :numbered: 5 - ./information/index.rst - ./specification/index.rst - ./lab-description/index.rst - ./configguide/index.rst - ./labs/index.rst + ./release/information/index.rst + ./release/release-notes/specification/index.rst + ./release/release-notes/lab-description/index.rst + ./release/configguide/index.rst + ./release/release-notes/labs/index.rst Indices ======= diff --git a/docs/configguide/configguide.rst b/docs/release/configguide/configguide.rst similarity index 100% rename from docs/configguide/configguide.rst rename to docs/release/configguide/configguide.rst diff --git a/docs/configguide/index.rst b/docs/release/configguide/index.rst similarity index 100% rename from docs/configguide/index.rst rename to docs/release/configguide/index.rst diff --git a/docs/configguide/jumpserverinstall.rst b/docs/release/configguide/jumpserverinstall.rst similarity index 100% rename from docs/configguide/jumpserverinstall.rst rename to docs/release/configguide/jumpserverinstall.rst diff --git a/docs/configguide/lab_update_guide.rst b/docs/release/configguide/lab_update_guide.rst similarity index 100% rename from docs/configguide/lab_update_guide.rst rename to docs/release/configguide/lab_update_guide.rst diff --git a/docs/images/ZTE-POD.jpg b/docs/release/images/ZTE-POD.jpg similarity index 100% rename from docs/images/ZTE-POD.jpg rename to docs/release/images/ZTE-POD.jpg diff --git a/docs/images/bridge1.png b/docs/release/images/bridge1.png similarity index 100% rename from docs/images/bridge1.png rename to docs/release/images/bridge1.png diff --git a/docs/images/bridge2.png b/docs/release/images/bridge2.png similarity index 100% rename from docs/images/bridge2.png rename to docs/release/images/bridge2.png diff --git a/docs/images/opnfv-example-lab-diagram.png b/docs/release/images/opnfv-example-lab-diagram.png similarity index 100% rename from docs/images/opnfv-example-lab-diagram.png rename to docs/release/images/opnfv-example-lab-diagram.png diff --git a/docs/images/opnfv-pharos-diagram-v01.jpg b/docs/release/images/opnfv-pharos-diagram-v01.jpg similarity index 100% rename from docs/images/opnfv-pharos-diagram-v01.jpg rename to docs/release/images/opnfv-pharos-diagram-v01.jpg diff --git a/docs/images/opnfv-test.jpg b/docs/release/images/opnfv-test.jpg similarity index 100% rename from docs/images/opnfv-test.jpg rename to docs/release/images/opnfv-test.jpg diff --git a/docs/images/pharos-archi1.jpg b/docs/release/images/pharos-archi1.jpg similarity index 100% rename from docs/images/pharos-archi1.jpg rename to docs/release/images/pharos-archi1.jpg diff --git a/docs/information/index.rst b/docs/release/information/index.rst similarity index 100% rename from docs/information/index.rst rename to docs/release/information/index.rst diff --git a/docs/information/pharos.rst b/docs/release/information/pharos.rst similarity index 100% rename from docs/information/pharos.rst rename to docs/release/information/pharos.rst diff --git a/docs/lab-description/images/lab_topology_example.jpg b/docs/release/release-notes/lab-description/images/lab_topology_example.jpg similarity index 100% rename from docs/lab-description/images/lab_topology_example.jpg rename to docs/release/release-notes/lab-description/images/lab_topology_example.jpg diff --git a/docs/lab-description/images/pod_topology_example.png b/docs/release/release-notes/lab-description/images/pod_topology_example.png similarity index 100% rename from docs/lab-description/images/pod_topology_example.png rename to docs/release/release-notes/lab-description/images/pod_topology_example.png diff --git a/docs/lab-description/index.rst b/docs/release/release-notes/lab-description/index.rst similarity index 100% rename from docs/lab-description/index.rst rename to docs/release/release-notes/lab-description/index.rst diff --git a/docs/lab-description/inventory.rst b/docs/release/release-notes/lab-description/inventory.rst similarity index 100% rename from docs/lab-description/inventory.rst rename to docs/release/release-notes/lab-description/inventory.rst diff --git a/docs/lab-description/lab_description.rst b/docs/release/release-notes/lab-description/lab_description.rst similarity index 100% rename from docs/lab-description/lab_description.rst rename to docs/release/release-notes/lab-description/lab_description.rst diff --git a/docs/lab-description/pod_description.rst b/docs/release/release-notes/lab-description/pod_description.rst similarity index 100% rename from docs/lab-description/pod_description.rst rename to docs/release/release-notes/lab-description/pod_description.rst diff --git a/docs/labs/Dell.rst b/docs/release/release-notes/labs/Dell.rst similarity index 100% rename from docs/labs/Dell.rst rename to docs/release/release-notes/labs/Dell.rst diff --git a/docs/labs/ericsson/images/ericsson-opnfv-topology.png b/docs/release/release-notes/labs/ericsson/images/ericsson-opnfv-topology.png similarity index 100% rename from docs/labs/ericsson/images/ericsson-opnfv-topology.png rename to docs/release/release-notes/labs/ericsson/images/ericsson-opnfv-topology.png diff --git a/docs/labs/ericsson/index.rst b/docs/release/release-notes/labs/ericsson/index.rst similarity index 100% rename from docs/labs/ericsson/index.rst rename to docs/release/release-notes/labs/ericsson/index.rst diff --git a/docs/labs/ericsson/lab_description.rst b/docs/release/release-notes/labs/ericsson/lab_description.rst similarity index 100% rename from docs/labs/ericsson/lab_description.rst rename to docs/release/release-notes/labs/ericsson/lab_description.rst diff --git a/docs/labs/huawei-us-lab/huawei-lab-pod.png b/docs/release/release-notes/labs/huawei-us-lab/huawei-lab-pod.png similarity index 100% rename from docs/labs/huawei-us-lab/huawei-lab-pod.png rename to docs/release/release-notes/labs/huawei-us-lab/huawei-lab-pod.png diff --git a/docs/labs/huawei-us-lab/huawei-lab-topology.png b/docs/release/release-notes/labs/huawei-us-lab/huawei-lab-topology.png similarity index 100% rename from docs/labs/huawei-us-lab/huawei-lab-topology.png rename to docs/release/release-notes/labs/huawei-us-lab/huawei-lab-topology.png diff --git a/docs/labs/huawei-us-lab/huawei-lab-virtual.png b/docs/release/release-notes/labs/huawei-us-lab/huawei-lab-virtual.png similarity index 100% rename from docs/labs/huawei-us-lab/huawei-lab-virtual.png rename to docs/release/release-notes/labs/huawei-us-lab/huawei-lab-virtual.png diff --git a/docs/labs/huawei-us-lab/index.rst b/docs/release/release-notes/labs/huawei-us-lab/index.rst similarity index 100% rename from docs/labs/huawei-us-lab/index.rst rename to docs/release/release-notes/labs/huawei-us-lab/index.rst diff --git a/docs/labs/huawei-us-lab/lab_specification.rst b/docs/release/release-notes/labs/huawei-us-lab/lab_specification.rst similarity index 100% rename from docs/labs/huawei-us-lab/lab_specification.rst rename to docs/release/release-notes/labs/huawei-us-lab/lab_specification.rst diff --git a/docs/labs/huawei-us-lab/net.png b/docs/release/release-notes/labs/huawei-us-lab/net.png similarity index 100% rename from docs/labs/huawei-us-lab/net.png rename to docs/release/release-notes/labs/huawei-us-lab/net.png diff --git a/docs/labs/huawei-us-lab/pod_specification.rst b/docs/release/release-notes/labs/huawei-us-lab/pod_specification.rst similarity index 100% rename from docs/labs/huawei-us-lab/pod_specification.rst rename to docs/release/release-notes/labs/huawei-us-lab/pod_specification.rst diff --git a/docs/labs/images/Dell_Overview.jpg b/docs/release/release-notes/labs/images/Dell_Overview.jpg similarity index 100% rename from docs/labs/images/Dell_Overview.jpg rename to docs/release/release-notes/labs/images/Dell_Overview.jpg diff --git a/docs/labs/images/Dell_POD1.jpg b/docs/release/release-notes/labs/images/Dell_POD1.jpg similarity index 100% rename from docs/labs/images/Dell_POD1.jpg rename to docs/release/release-notes/labs/images/Dell_POD1.jpg diff --git a/docs/labs/images/Dell_POD2.jpg b/docs/release/release-notes/labs/images/Dell_POD2.jpg similarity index 100% rename from docs/labs/images/Dell_POD2.jpg rename to docs/release/release-notes/labs/images/Dell_POD2.jpg diff --git a/docs/labs/images/Dell_POD3.jpg b/docs/release/release-notes/labs/images/Dell_POD3.jpg similarity index 100% rename from docs/labs/images/Dell_POD3.jpg rename to docs/release/release-notes/labs/images/Dell_POD3.jpg diff --git a/docs/labs/images/orange_paris_pod1.jpg b/docs/release/release-notes/labs/images/orange_paris_pod1.jpg similarity index 100% rename from docs/labs/images/orange_paris_pod1.jpg rename to docs/release/release-notes/labs/images/orange_paris_pod1.jpg diff --git a/docs/labs/images/orange_pod2.png b/docs/release/release-notes/labs/images/orange_pod2.png similarity index 100% rename from docs/labs/images/orange_pod2.png rename to docs/release/release-notes/labs/images/orange_pod2.png diff --git a/docs/labs/images/spirent_vptc-public-drawing.png b/docs/release/release-notes/labs/images/spirent_vptc-public-drawing.png similarity index 100% rename from docs/labs/images/spirent_vptc-public-drawing.png rename to docs/release/release-notes/labs/images/spirent_vptc-public-drawing.png diff --git a/docs/labs/index.rst b/docs/release/release-notes/labs/index.rst similarity index 100% rename from docs/labs/index.rst rename to docs/release/release-notes/labs/index.rst diff --git a/docs/labs/ool/images/ool-testlab.png b/docs/release/release-notes/labs/ool/images/ool-testlab.png similarity index 100% rename from docs/labs/ool/images/ool-testlab.png rename to docs/release/release-notes/labs/ool/images/ool-testlab.png diff --git a/docs/labs/ool/index.rst b/docs/release/release-notes/labs/ool/index.rst similarity index 100% rename from docs/labs/ool/index.rst rename to docs/release/release-notes/labs/ool/index.rst diff --git a/docs/labs/ool/inventory.rst b/docs/release/release-notes/labs/ool/inventory.rst similarity index 100% rename from docs/labs/ool/inventory.rst rename to docs/release/release-notes/labs/ool/inventory.rst diff --git a/docs/labs/ool/lab_description.rst b/docs/release/release-notes/labs/ool/lab_description.rst similarity index 100% rename from docs/labs/ool/lab_description.rst rename to docs/release/release-notes/labs/ool/lab_description.rst diff --git a/docs/labs/ool/pod1_description.rst b/docs/release/release-notes/labs/ool/pod1_description.rst similarity index 100% rename from docs/labs/ool/pod1_description.rst rename to docs/release/release-notes/labs/ool/pod1_description.rst diff --git a/docs/labs/ool/pod1_inventory.yaml b/docs/release/release-notes/labs/ool/pod1_inventory.yaml similarity index 100% rename from docs/labs/ool/pod1_inventory.yaml rename to docs/release/release-notes/labs/ool/pod1_inventory.yaml diff --git a/docs/labs/ool/virtual1_description.rst b/docs/release/release-notes/labs/ool/virtual1_description.rst similarity index 100% rename from docs/labs/ool/virtual1_description.rst rename to docs/release/release-notes/labs/ool/virtual1_description.rst diff --git a/docs/labs/orange-lannion-lab/index.rst b/docs/release/release-notes/labs/orange-lannion-lab/index.rst similarity index 100% rename from docs/labs/orange-lannion-lab/index.rst rename to docs/release/release-notes/labs/orange-lannion-lab/index.rst diff --git a/docs/labs/orange-paris-lab/index.rst b/docs/release/release-notes/labs/orange-paris-lab/index.rst similarity index 100% rename from docs/labs/orange-paris-lab/index.rst rename to docs/release/release-notes/labs/orange-paris-lab/index.rst diff --git a/docs/labs/orange-paris-lab/orange_paris_lab_description.rst b/docs/release/release-notes/labs/orange-paris-lab/orange_paris_lab_description.rst similarity index 100% rename from docs/labs/orange-paris-lab/orange_paris_lab_description.rst rename to docs/release/release-notes/labs/orange-paris-lab/orange_paris_lab_description.rst diff --git a/docs/labs/orange-paris-lab/orange_paris_pod1_description.rst b/docs/release/release-notes/labs/orange-paris-lab/orange_paris_pod1_description.rst similarity index 100% rename from docs/labs/orange-paris-lab/orange_paris_pod1_description.rst rename to docs/release/release-notes/labs/orange-paris-lab/orange_paris_pod1_description.rst diff --git a/docs/labs/spirent.rst b/docs/release/release-notes/labs/spirent.rst similarity index 100% rename from docs/labs/spirent.rst rename to docs/release/release-notes/labs/spirent.rst diff --git a/docs/labs/zte-sh-lab/images/zte_sh_lab_topology.png b/docs/release/release-notes/labs/zte-sh-lab/images/zte_sh_lab_topology.png similarity index 100% rename from docs/labs/zte-sh-lab/images/zte_sh_lab_topology.png rename to docs/release/release-notes/labs/zte-sh-lab/images/zte_sh_lab_topology.png diff --git a/docs/labs/zte-sh-lab/images/zte_sh_pod_topology.png b/docs/release/release-notes/labs/zte-sh-lab/images/zte_sh_pod_topology.png similarity index 100% rename from docs/labs/zte-sh-lab/images/zte_sh_pod_topology.png rename to docs/release/release-notes/labs/zte-sh-lab/images/zte_sh_pod_topology.png diff --git a/docs/labs/zte-sh-lab/index.rst b/docs/release/release-notes/labs/zte-sh-lab/index.rst similarity index 100% rename from docs/labs/zte-sh-lab/index.rst rename to docs/release/release-notes/labs/zte-sh-lab/index.rst diff --git a/docs/labs/zte-sh-lab/lab_description.rst b/docs/release/release-notes/labs/zte-sh-lab/lab_description.rst similarity index 100% rename from docs/labs/zte-sh-lab/lab_description.rst rename to docs/release/release-notes/labs/zte-sh-lab/lab_description.rst diff --git a/docs/labs/zte-sh-lab/pod-1.rst b/docs/release/release-notes/labs/zte-sh-lab/pod-1.rst similarity index 100% rename from docs/labs/zte-sh-lab/pod-1.rst rename to docs/release/release-notes/labs/zte-sh-lab/pod-1.rst diff --git a/docs/labs/zte-sh-lab/pod-1.yaml b/docs/release/release-notes/labs/zte-sh-lab/pod-1.yaml similarity index 100% rename from docs/labs/zte-sh-lab/pod-1.yaml rename to docs/release/release-notes/labs/zte-sh-lab/pod-1.yaml diff --git a/docs/labs/zte-sh-lab/pod-2.rst b/docs/release/release-notes/labs/zte-sh-lab/pod-2.rst similarity index 100% rename from docs/labs/zte-sh-lab/pod-2.rst rename to docs/release/release-notes/labs/zte-sh-lab/pod-2.rst diff --git a/docs/labs/zte-sh-lab/pod-2.yaml b/docs/release/release-notes/labs/zte-sh-lab/pod-2.yaml similarity index 100% rename from docs/labs/zte-sh-lab/pod-2.yaml rename to docs/release/release-notes/labs/zte-sh-lab/pod-2.yaml diff --git a/docs/labs/zte-sh-lab/pod-3.rst b/docs/release/release-notes/labs/zte-sh-lab/pod-3.rst similarity index 100% rename from docs/labs/zte-sh-lab/pod-3.rst rename to docs/release/release-notes/labs/zte-sh-lab/pod-3.rst diff --git a/docs/labs/zte-sh-lab/pod-3.yaml b/docs/release/release-notes/labs/zte-sh-lab/pod-3.yaml similarity index 100% rename from docs/labs/zte-sh-lab/pod-3.yaml rename to docs/release/release-notes/labs/zte-sh-lab/pod-3.yaml diff --git a/docs/platformoverview/labinfrastructure.rst b/docs/release/release-notes/platformoverview/labinfrastructure.rst similarity index 100% rename from docs/platformoverview/labinfrastructure.rst rename to docs/release/release-notes/platformoverview/labinfrastructure.rst diff --git a/docs/specification/hardwarespec.rst b/docs/release/release-notes/specification/hardwarespec.rst similarity index 100% rename from docs/specification/hardwarespec.rst rename to docs/release/release-notes/specification/hardwarespec.rst diff --git a/docs/specification/index.rst b/docs/release/release-notes/specification/index.rst similarity index 100% rename from docs/specification/index.rst rename to docs/release/release-notes/specification/index.rst diff --git a/docs/specification/networkconfig.rst b/docs/release/release-notes/specification/networkconfig.rst similarity index 93% rename from docs/specification/networkconfig.rst rename to docs/release/release-notes/specification/networkconfig.rst index fa95faa5..fb9d5111 100644 --- a/docs/specification/networkconfig.rst +++ b/docs/release/release-notes/specification/networkconfig.rst @@ -51,11 +51,11 @@ Documented configuration to include: **Sample Network Drawings** -.. image:: ../images/bridge2.png +.. image:: ../../images/bridge2.png -.. image:: ../images/opnfv-pharos-diagram-v01.jpg +.. image:: ../../images/opnfv-pharos-diagram-v01.jpg -.. image:: ../images/opnfv-example-lab-diagram.png +.. image:: ../../images/opnfv-example-lab-diagram.png Download the visio zip file here: `opnfv-example-lab-diagram.vsdx.zip diff --git a/docs/specification/objectives.rst b/docs/release/release-notes/specification/objectives.rst similarity index 100% rename from docs/specification/objectives.rst rename to docs/release/release-notes/specification/objectives.rst diff --git a/docs/specification/remoteaccess.rst b/docs/release/release-notes/specification/remoteaccess.rst similarity index 100% rename from docs/specification/remoteaccess.rst rename to docs/release/release-notes/specification/remoteaccess.rst diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/release/userguide/documentation-example.rst similarity index 100% rename from docs/how-to-use-docs/documentation-example.rst rename to docs/release/userguide/documentation-example.rst diff --git a/docs/how-to-use-docs/index.rst b/docs/release/userguide/index.rst similarity index 93% rename from docs/how-to-use-docs/index.rst rename to docs/release/userguide/index.rst index 2fea43e0..bdd70ee8 100644 --- a/docs/how-to-use-docs/index.rst +++ b/docs/release/userguide/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -.. image:: ../etc/opnfv-logo.png +.. image:: ../../etc/opnfv-logo.png :height: 40 :width: 200 :alt: OPNFV