blob: 9292b13af849ef7403ba353d188b4d182e930701 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
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.
**Documentation tracking**
+-----------------+---------------------------------------------------------+
| Revision | ${GIT_REVISION} |
+-----------------+---------------------------------------------------------+
| Build date | ${BUILD_ID} |
+-----------------+---------------------------------------------------------+
|
