Versions Compared

Version Old Version 12 New Version 13
Changes made by

Andreas Geißler

Andreas Geißler

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

TimeNameTopic/taskOutcome

Andreas Geißler Thomas Kulik

Default structure for ONAP functional/non-functional modules/projects (to easily build views later on; context here is the discussion with Chaker)

 proposed 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 Guide
    • Human Interfaces
  • Administration and Operation
    • Installation
    • Configuration
    • Logging
  • Developer Guides
  • Release NotesNote

b) define a "label template" for each chapter to create cross-reference to.→ develop a RST template for module documentation (maybe a task for technical writers)

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

  • Architecture
  • User Guides
  • Administation and Operation
  • Developer Guides

possible further enhancements:

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

Andreas Geißler Thomas Kulik

Migration/Deprecation of docs (Wiki/RTD) (plus helper script in doc/tools)




Thomas KulikReduction of RST warnings (plus helper script in doc/tools)


Andreas GeißlerPossible topics for technical writers hired by LFN

























...