Content Comparison

Andreas Geißler Thomas Kulik

1. develop a RST template for module documentation (maybe a task for technical writers)

 a) proposed structure for Modules:

• Architecture
• Offered APIs
• Consumed APIs
• User Guides
  • Human Interfaces
• Administration and Operation Guides
  • Installation
  • Configuration
  • Logging
• Developer Guides
• Release Note

b) define a "label template" for each chapter to create cross-reference to.

2. develop "landing pages" (as in Chacker's proposal) with clickable figures to jump to the right content in

• Architecture
  • Link to E2E Architecture and Module Architecture
• User Guides
  • Link to E2E Guides and Module guides
• Administation and Operation
  • Link to E2E Guides and Module guides
• Developer Guides
• Security

possible further enhancements:

• define "Tags" to define filter criteria → needs to be checked

Andreas Geißler Thomas Kulik

• Start with the following Wiki pages:
  • Documenting ONAP
  • Architecture
  • Developing ONAP (partly)
  • Setting up ONAP (partly)
  • Integrating with ONAP
  • Supporting Tools
• Take support by the community to decide on content and migration
• tools currently stored in the doc/tools repo will be moved to the doc repo (under doc/tools directory) (see topic below)