2019 April 17th Documentation Hackathon

April 17th - 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... 



Name

Topic/task

Outcome

Name

Topic/task

Outcome

@Andreas Geißler

Provide RST file for Pre-Onboarding, Resource Onboarding

RST files from wiki

DOC-435: User Guide - Service Design - Pre-OnboardingClosed

DOC-436: User Guide - Service Design - Resource-OnboardingClosed



@Eric Debeau

Provide RST file for VF Creation and Testing, Control Loop Design

RST files from wiki

DOC-437: User Guide - Service Design - VF Creation and TestingClosed

DOC-438: User Guide - Service Design - Governance Approval and Service DistributionClosed



@David Perez Caparros

Provide RST description for BBS use-case

New RST file

DOC-431: BBS use case documentationClosed

DOC-432: Add BBS blueprint description to onap architectureClosed

Available on reasthedocs: https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html

@Sofia Wallin

Walking through all tickets assigned the Dublin Release (fixVersion = "Dublin Release" AND labels = Documentation AND status = Open)

Following up with all projects the status of the tickets planned for the release

@Eric Debeau

Creation of the user story to cover User Guide for Service Design

DOC-434: Convert the User Guide - Service Design part from the wiki to RSTClosed

@Rich Bennett @Sofia Wallin

DOC-410: Implement a similar layout than OPNFVClosed

Changes made locally with great output. Some modifications needed before added to master and docs.onap.org

unnamed link

Clarify API documentation guide and explain the file location DOC-426: Add documentation guide for APIClosed

Changes merged https://gerrit.onap.org/r/#/c/85606/

INFO

Quick check/test

There could be some format errors in the converted file which needs manually modification.

You can use an online editor for checking the output of the rst file or finding errors.

  • open the website http://rst.ninjs.org/

  • type the input in the left column or copy your rst file content into it

  • wait a few seconds, and the output would be shown in the right column

  • you can check the output (as well as warnings) in the right column







Add a "Release Documentation" reference from from wiki.onap.org main page



@FREEMAN, BRIAN D

Update OOM Quick Install Guide for OOM-1786: Need to clarify how to setup the Openstack parametersClosed

Changes submitted https://gerrit.onap.org/r/#/c/85611/

@Dominic Lunanuova

Update Dmaap API with Swagger DMAAP-922: [DMAAP] Integration with SwaggerClosed

Changes merged https://gerrit.onap.org/r/#/c/85622/

unnamed link

@Eric Debeau presented the Postman collection available within the integration project: https://git.onap.org/integration/tree/test/postman

Dmaap project will provide collection

Documentation to explain how to use these API and where to find them

 @Gervais-Martial Ngueko

 made some updates on Control Loop Design

 align the page with current behavour (not finished yet)





Date and Time

Time zone

Date

Time

Participants

Time zone

Date

Time

Participants

CET

April 17th

09:00-16:00

@Eric Debeau@Andreas Geißler

@Thomas Kulik

EDT

April 17th

09:00-16:00

@Rich Bennett

PST

April 17th

06:00-09:00

@Eric Debeau@Andreas Geißler

Logistics:

ONAP Meeting 1 is inviting you to a scheduled Zoom meeting.

https://zoom.us/j/408178599

One tap mobile
+16465588656,,408178599# US (New York)
+16699006833,,408178599# US (San Jose)

Dial by your location
        +1 646 558 8656 US (New York)
        +1 669 900 6833 US (San Jose)
        877 369 0926 US Toll-free
        855 880 1246 US Toll-free
Meeting ID: 408 178 599
Find your local number: https://zoom.us/u/aehHSGCuec