From: Victor Laza <vlaza@cloudbasesolutions.com>
Date: Fri, 3 Apr 2015 13:46:12 +0000 (+0300)
Subject: JIRA: DOCS-2 - docs/main.rst file for docu-generation in opnfvdocs
X-Git-Tag: arno.2015.1.0~24
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F54%2F254%2F3;p=opnfvdocs.git

JIRA: DOCS-2 - docs/main.rst file for docu-generation in opnfvdocs

docs/main.rst contain basic .rst markup language with source from
https://wiki.opnfv.org/documentation_projects/opnfv_documentation

Change-Id: I84a72956a7455b1c24459811dd579af0082c4246
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
---

diff --git a/docs/main.rst b/docs/main.rst
new file mode 100644
index 000000000..49ac4329b
--- /dev/null
+++ b/docs/main.rst
@@ -0,0 +1,95 @@
+Project Name: Documentation
+============================
+
+- Proposed name for the project: ''opnfv documentation''
+- Proposed name for the repository: ''opnfvdocs''
+- Project Categories: Documentation
+
+Project description:
+---------------------
+
+- Produce documentation for OPNFV releases including but not limited to:
+
+  - Release notes
+  - Installation guide
+  - User guide
+
+    - Any relevant references and interface specifications for OPNFV projects or components.
+
+  - Include any architecture diagrams or specifications, reference to OPNFV requirements list.
+  - Provide guidelines and tooling for documentation handling across all OPNFV projects
+
+Scope:
+-------
+
+- Set up a structure, and a template, for document development with source control (same as source code). Leveraging upstream documentation structure and tools.
+- Following as close as possible the same contribution process & tools as our source code
+- Structure OPNFV documentation logically
+- Develop initial set of release documents:
+
+  - Release note
+  - Install guide
+  - User Guide
+  - API reference (if there is content in release 1)
+  - Interface specification  (if there is content in release 1)
+
+- Provide language options for documentation where applicable: In first release English only, Wiki (via HTML scraping from Gerrit), and PDF.
+- Provide tooling and processes for OPNFV projects to implement and follow for consistency
+
+Dependencies:
+--------------
+
+- All OPNFV projects participating in a release.
+- Upstream project documentation to be referenced
+- Where there are external fora or standard development organization dependencies, list informative and normative references & specifications.
+
+
+Committers and Contributors:
+-----------------------------
+
+- Name of and affiliation of the project leader :
+
+  - Christopher Price: christopher.price@ericsson.com
+
+- Names and affiliations of the committers
+
+  - Christopher Price: christopher.price@ericsson.com
+  - Wenjing Chu (Dell):  wenjing_chu@dell.com
+  - Ashiq Khan (NTTdocomo): khan@nttdocomo.com
+  - Fatih Degirmenci: fatih.degirmenci@ericsson.com
+  - Rodriguez, Iben: Iben.Rodriguez@spirent.com
+  - Malla Reddy Sama: sama@docomolab-euro.com
+
+- Any other contributors
+
+  - Bryan Sullivan (AT&T)
+  - Trevor Cooper: trevor.cooper@intel.com
+
+
+Description of roles in the documentation project:
+
+- Committers (Editors): has overall responsibility of document structure, editing, style and toolchains
+- opnfvdocs contributors: individual section will have contributors who are domain experts in those areas, other contributors may simply help out working on the documentation and tools as needed.
+- other projects: Committers will be responsible for maintaining documentation artifacts in project repositories.
+
+Planned deliverables
+---------------------
+
+- Project release documentation for OPNFV
+
+  - Including collation of all release relevant project documentations
+
+- Establishment and maintenance of the OPNFV documentation processes and toolchains
+
+
+Proposed Release Schedule:
+---------------------------
+
+- opnfvdocs will follow each OPNFV release and produce needed documentation
+
+  - Release 1 will provide basic documentation including revision control.
+  - By release 2 a multi-project toolchain will be in place with processes and version control
+  - Iterative improvements to the processes and toolchains are expected on a release by release basis.
+
+
+