summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFatih Degirmenci <fatih.degirmenci@ericsson.com>2017-08-27 22:15:12 +0200
committerSofia Wallin <sofia.wallin@ericsson.com>2017-10-02 14:40:08 +0000
commit4e019e1b15ee56e40750731342383cab30246165 (patch)
treec5f309027cac62325f69906626a63d61412ccd52
parent7f282f2fa05636eadb19323cdc8a0fe14a19c28a (diff)
infra: Add proposal for including infra documentation
This change proposes addition of infrastructure to OPNFV Documentation on RTD. Proposed sections are - software-infrastructure: proposal to move documentation for OPNFV software infrastructure such as Gerrit, Artifact Repository, Jenkins, and so on, from OPNFV Wiki [1] to RTD. - continuous-integration: proposal to move documentation for OPNFV Continuous Integration from OPNFV Wiki [2] to RTD. - cross-community-continuous-integration: proposal to move documentation for OPNFV XCI from OPNFV Wiki [3] to RTD. Proposal for including the documentation for hardware infrastructure is not included in this change as there is already documentation in different place on RTD. It will be clarified later. [1] https://wiki.opnfv.org/display/INF/Software+Infrastructure [2] https://wiki.opnfv.org/display/INF/Continuous+Integration [3] https://wiki.opnfv.org/pages/viewpage.action?pageId=8687635 Change-Id: I4f22d9f22135c70b55b5e92aa3338a4c3889bee1 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com> (cherry picked from commit 65d3200b8ae2a4ec9763d0abc1e8e14809691306)
-rw-r--r--docs/how-to-use-docs/documentation-guide.rst15
-rw-r--r--docs/infrastructure/overview.rst14
2 files changed, 25 insertions, 4 deletions
diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/how-to-use-docs/documentation-guide.rst
index fed42a451..3a3b0c40d 100644
--- a/docs/how-to-use-docs/documentation-guide.rst
+++ b/docs/how-to-use-docs/documentation-guide.rst
@@ -62,10 +62,13 @@ Following representation shows the expected structure:
│ ├── scenarios
│ │ └── scenario.name
│ └── userguide
- └── testing
- ├── developer
- └── user
-
+ ├── testing
+ │ ├── developer
+ │ └── user
+ └── infrastructure
+ ├── software-infrastructure
+ ├── continuous-integration
+ └── cross-community-continuous-integration
Release documentation
^^^^^^^^^^^^^^^^^^^^^
@@ -133,3 +136,7 @@ You are encouraged to establish the following basic structure for your project a
**Project overview**: :code:`<repo>/docs/development/overview`
- Folder for any project specific documentation.
+
+Infrastructure Documentation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Infrastructure documentation can be stored under code:`<repo>/docs/infrastructure/` folder.
diff --git a/docs/infrastructure/overview.rst b/docs/infrastructure/overview.rst
new file mode 100644
index 000000000..e80838628
--- /dev/null
+++ b/docs/infrastructure/overview.rst
@@ -0,0 +1,14 @@
+.. _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