docs/main.rst

   1 Project Name: Documentation
   2 ============================
   3
   4 - Proposed name for the project: ''opnfv documentation''
   5 - Proposed name for the repository: ''opnfvdocs''
   6 - Project Categories: Documentation
   7
   8 Project description:
   9 ---------------------
  10
  11 - Produce documentation for OPNFV releases including but not limited to:
  12
  13   - Release notes
  14   - Installation guide
  15   - User guide
  16
  17     - Any relevant references and interface specifications for OPNFV projects or components.
  18
  19   - Include any architecture diagrams or specifications, reference to OPNFV requirements list.
  20   - Provide guidelines and tooling for documentation handling across all OPNFV projects
  21
  22 Scope:
  23 -------
  24
  25 - Set up a structure, and a template, for document development with source control (same as source code). Leveraging upstream documentation structure and tools.
  26 - Following as close as possible the same contribution process & tools as our source code
  27 - Structure OPNFV documentation logically
  28 - Develop initial set of release documents:
  29
  30   - Release note
  31   - Install guide
  32   - User Guide
  33   - API reference (if there is content in release 1)
  34   - Interface specification  (if there is content in release 1)
  35
  36 - Provide language options for documentation where applicable: In first release English only, Wiki (via HTML scraping from Gerrit), and PDF.
  37 - Provide tooling and processes for OPNFV projects to implement and follow for consistency
  38
  39 Dependencies:
  40 --------------
  41
  42 - All OPNFV projects participating in a release.
  43 - Upstream project documentation to be referenced
  44 - Where there are external fora or standard development organization dependencies, list informative and normative references & specifications.
  45
  46
  47 Committers and Contributors:
  48 -----------------------------
  49
  50 - Name of and affiliation of the project leader :
  51
  52   - Christopher Price: christopher.price@ericsson.com
  53
  54 - Names and affiliations of the committers
  55
  56   - Christopher Price: christopher.price@ericsson.com
  57   - Wenjing Chu (Dell):  wenjing_chu@dell.com
  58   - Ashiq Khan (NTTdocomo): khan@nttdocomo.com
  59   - Fatih Degirmenci: fatih.degirmenci@ericsson.com
  60   - Rodriguez, Iben: Iben.Rodriguez@spirent.com
  61   - Malla Reddy Sama: sama@docomolab-euro.com
  62
  63 - Any other contributors
  64
  65   - Bryan Sullivan (AT&T)
  66   - Trevor Cooper: trevor.cooper@intel.com
  67
  68
  69 Description of roles in the documentation project:
  70
  71 - Committers (Editors): has overall responsibility of document structure, editing, style and toolchains
  72 - 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.
  73 - other projects: Committers will be responsible for maintaining documentation artifacts in project repositories.
  74
  75 Planned deliverables
  76 ---------------------
  77
  78 - Project release documentation for OPNFV
  79
  80   - Including collation of all release relevant project documentations
  81
  82 - Establishment and maintenance of the OPNFV documentation processes and toolchains
  83
  84
  85 Proposed Release Schedule:
  86 ---------------------------
  87
  88 - opnfvdocs will follow each OPNFV release and produce needed documentation
  89
  90   - Release 1 will provide basic documentation including revision control.
  91   - By release 2 a multi-project toolchain will be in place with processes and version control
  92   - Iterative improvements to the processes and toolchains are expected on a release by release basis.
  93
  94
  95