2019 May 14th Documentation Hackathon

Owned by Sofia Wallin
Last updated: Mar 19, 2020 by Andreas Geißler
2 min read

May 14th - Virtual Event

Location - Virtual partcitation

This event will be be a virtual hacking session focusing on the Dublin Release. The call with be open throughout the day of Wednesday 17th. 

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 Dublin specific content. 



Potential topics/Agenda

  • On-going Docs JIRA tickets

  • Project documentation for the Dublin release

    • HowTo Start with ONAP

    • HowTo Learn ONAP using Postman API collections

    • ONAP overview description

  • Learn more about how to work with documentation

  • Documentation improvements 

  • Documentation templates

  • Documentation and use-case articulation: how to document use-cases

  • Documentation and architecture articulation

  • Documentation and security (@Pawel Pawlak)

  • Documentation and modeling to produce a common glossary

  • Move (and mark/delete) documents from Wiki to ReadTheDocs (e.g. in UserGuide)

  • add more...

  • Dublin Documentation Review



Name

Topic/task

Outcome

Name

Topic/task

Outcome

@Andreas Geißler
@Thomas Kulik

Work of a proposal for the target content structure for ReadTheDocs,
possibly more detailed substructure for User Guide (based on Proposed Structure of Guides)

Structural proposal (e.g. Mindmap, Excel) for further discussion and implementation

@Andreas Geißler

How to verify DOC pages with projects ? 
If content of DOC pages need review by ONAP projects, should there be a
"Pairewise Testing" between DOC and other projects (Integration Weather Board for Dublin Release) ?

Proposal for El Alto

@Andreas Geißler

Clear Status about Wiki2RST migration of SDC Workflow Designer (https://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/workflow.html)

and DCAE-DS (https://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/dcaedesigner.html),
as well as update of "Human Interfaces" (https://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/humaninterfaces.html)



@Eric Debeau

Evaluate existing rmaining JIRA issues related to documentation

Corrected DOC-426, DCAEGEN2-1049



@Sofia Wallin

Open Jira tickets for the Doc project - 

type key summary assignee reporter priority status resolution created updated due
Refresh



@Sofia Wallin

Open Jira tickets for all (including doc project) - 

type key summary assignee reporter priority status resolution created updated due
Refresh



@Eric Debeau

Creation of Dublin Documentation Review



@Sofia Wallin

Dublin updates https://gerrit.onap.org/r/#/c/87650/





































Date and Time

Time zone

Date

Time

Participants

Time zone

Date

Time

Participants

CET

April 17th

09:00-16:00

@Eric Debeau



EDT

April 17th

09:00-16:00



PST

April 17th

06:00-09:00



Logistics:

TBA