diff options
| author |   Fatih Degirmenci <fatih.degirmenci@ericsson.com> | 2017-09-29 10:38:17 +0200 |
|---|---|---|
| committer |   Sofia Wallin <sofia.wallin@ericsson.com> | 2017-10-02 14:44:22 +0000 |
| commit | 72fa8ee93196400b9b59d4750bc26bd479ca28e8 (patch) | |
| tree | 3340e8b1a6a3892012658e97a27294a694c0e3e8 | |
| parent | b8aa696f89e07d813b4efc0a9fb5634fe870ef1f (diff) | |
Put initial structure for infra documentation
Change-Id: I4d8ed269cbf0eeedaa0ee540ac2fd6bca5e429b0
Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
(cherry picked from commit 8f61a93218c0e5427e147a180e7e21a902176dea)
| -rw-r--r-- | docs/how-to-use-docs/documentation-guide.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/infrastructure/infrastructure-overview.rst | 47 | ||||
| -rw-r--r-- | docs/infrastructure/overview.rst | 14 |
4 files changed, 52 insertions, 15 deletions
diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/how-to-use-docs/documentation-guide.rst index 3a3b0c40d..56bf273bc 100644 --- a/docs/how-to-use-docs/documentation-guide.rst +++ b/docs/how-to-use-docs/documentation-guide.rst @@ -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. diff --git a/docs/index.rst b/docs/index.rst index c5ca8364a..7fe649a47 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 index 000000000..879d3dbe4 --- /dev/null +++ b/docs/infrastructure/infrastructure-overview.rst @@ -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 index e80838628..000000000 --- a/docs/infrastructure/overview.rst +++ /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 |