Put initial structure for infra documentation 85/43585/8
authorFatih Degirmenci <fatih.degirmenci@ericsson.com>
Fri, 29 Sep 2017 08:38:17 +0000 (10:38 +0200)
committerFatih Degirmenci <fatih.degirmenci@ericsson.com>
Fri, 29 Sep 2017 10:02:00 +0000 (12:02 +0200)
Change-Id: I4d8ed269cbf0eeedaa0ee540ac2fd6bca5e429b0
Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
docs/how-to-use-docs/documentation-guide.rst
docs/index.rst
docs/infrastructure/infrastructure-overview.rst [new file with mode: 0644]
docs/infrastructure/overview.rst [deleted file]

index 3a3b0c4..56bf273 100644 (file)
@@ -66,6 +66,7 @@ Following representation shows the expected structure:
         │   ├── developer
         │   └── user
         └── infrastructure
+            ├── hardware-infrastructure
             ├── software-infrastructure
             ├── continuous-integration
             └── cross-community-continuous-integration
@@ -139,4 +140,5 @@ You are encouraged to establish the following basic structure for your project a
 
 Infrastructure Documentation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Infrastructure documentation can be stored under code:`<repo>/docs/infrastructure/` folder.
+Infrastructure documentation can be stored under :code:`<repo>/docs/` folder of
+corresponding infrastructure project.
index c5ca836..7fe649a 100644 (file)
@@ -50,3 +50,5 @@ Infrastructure
 
 .. toctree::
    :maxdepth: 1
+
+   infrastructure/infrastructure-overview
diff --git a/docs/infrastructure/infrastructure-overview.rst b/docs/infrastructure/infrastructure-overview.rst
new file mode 100644 (file)
index 0000000..879d3db
--- /dev/null
@@ -0,0 +1,47 @@
+.. _infrastructure-overview:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+=======================
+Infrastructure Overview
+=======================
+
+OPNFV develops, maintains and operates infrastructure which is used by OPNFV
+Community for development, integration, and testing purposes. `OPNFV
+Infrastructure Working Group (Infra WG) <https://wiki.opnfv.org/display/INF>`_
+oversees the OPNFV Infrastructure, ensures it is kept in a state which serves
+the community in best possible way and always up to date.
+
+The details of what is provided as part of infrastructure can be seen in
+following chapters.
+
+Hardware Infrastructure
+-----------------------
+
+TBD
+
+Software Infrastructure
+-----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   ../submodules/releng/docs/sofware-infrastructure-index
+
+Continuous Integration (CI)
+---------------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   ../submodules/releng/docs/ci-index
+
+Cross Community Continuous Integration (XCI)
+--------------------------------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   ../submodules/releng/docs/xci-index
diff --git a/docs/infrastructure/overview.rst b/docs/infrastructure/overview.rst
deleted file mode 100644 (file)
index e808386..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-.. _opnfv-overview:
-
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. SPDX-License-Identifier: CC-BY-4.0
-.. (c) Open Platform for NFV Project, Inc. and its contributors
-
-=======================
-Infrastructure overview
-=======================
-
-Introduction
-============
-
-TBD