diff options
| author |   Fatih Degirmenci <fatih.degirmenci@ericsson.com> | 2017-08-27 22:15:12 +0200 |
|---|---|---|
| committer | Fatih Degirmenci <fatih.degirmenci@ericsson.com> | 2017-08-27 23:00:07 +0200 |
| commit | 65d3200b8ae2a4ec9763d0abc1e8e14809691306 (patch) | |
| tree | 8a3ee1f9b00f4615065a8b0ea5b864816102df13 /docs/how-to-use-docs | |
| parent | 9ec35c40e677f83b2dd627fee3c720a0f6993d35 (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>
Diffstat (limited to 'docs/how-to-use-docs')
| -rw-r--r-- | docs/how-to-use-docs/documentation-guide.rst | 15 |
1 files changed, 11 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. |