summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorFatih Degirmenci <fatih.degirmenci@ericsson.com>2017-09-21 11:39:26 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-09-21 11:39:26 +0000
commit25ac553d237ca790ceaf3e39fdb0564cb8d4c396 (patch)
tree63c415823e0033ac26b1b26d684cc65f3956e66f /docs
parente1e49e7e7ceb3a3e1bba96b89784adb638a37b4b (diff)
parent65d3200b8ae2a4ec9763d0abc1e8e14809691306 (diff)
Merge "infra: Add proposal for including infra documentation"
Diffstat (limited to 'docs')
-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