You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Virtual Event

Location - Virtual partcitation

This event will be be a virtual hacking session focusing on the Frankfurt Release. The call with be open throughout the day of Wednesday 11th (so far CET).

When joining the call please let us know that you joined and we will support to navigate the day. The topics will be much depended on the audience, whether we will focus on introduction on how to work with documentation, ongoing improvements or Frankfurt specific content. 


Potential topics/Agenda

  • On-going Docs JIRA tickets
  • Project documentation for the Frankfurt release
  • Learn more about how to work with documentation
  • Submodule removal 
  • <addme>


TimeNameTopic/taskOutcome

Andreas Geissler Thomas Kulik

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

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 Geissler 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 GeisslerPossible topics for technical writers hired by LFN
  • Should support the whole ONAP community 
  • Can create templates (see topic 1, release notes templates) 



























Date and Time

Time zoneDateTimeParticipants
CETMarch 11th10:00-17:00

Sofia Wallin

EDT


PST


Logistics:

Join Zoom Meeting
https://zoom.us/j/5969891148

Meeting ID: 596 989 1148

One tap mobile
+16699006833,,5969891148# US (San Jose)
+19292056099,,5969891148# US (New York)

Dial by your location
+1 669 900 6833 US (San Jose)
+1 929 205 6099 US (New York)
Meeting ID: 596 989 1148
Find your local number: https://zoom.us/u/aciqL3YTpP

  • No labels