2020 October 14th Documentation Hackathon (Guilin Release)

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

Virtual Event

This event will be be a virtual hacking session focusing on the Guilin Release. https://wiki.lfnetworking.org/display/LN/2020+October+Virtual+Technical+Event+Topic+Proposals#id-2020OctoberVirtualTechnicalEventTopicProposals-ONAPDocs:Hackathon/reviews

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



Potential topics/Agenda

  • Learn more about how to work with documentation

  • Guilin specific updates

  • Documentation reviews

  • <addme>



Name

Topic/task

Outcome

Name

Topic/task

Outcome



Self release for documentation 



@Andreas Geißler @Eric Debeau @ChrisC

Deep-dive SDC documentation 

<addme>

@Andreas Geißler
@Thomas Kulik
(12:00-15:00)


  • Complete the list of existing documents (Guilin Documentation)

  • Add git project reference to list

  • Possible automation for list... (maybe via Jenkins)

  • Verify list with PTLs, if incomplete

Updated our Working Review List (Copy of Guilin Documentation (working version for reviews))

@Andreas Geißler
@Thomas Kulik
(12:00-15:00)

  • Put to TSC agenda to come up with a Release strategy.


  • Add for each project a release branch,....

@Sofia Wallin

Release requirement for documentation   

We need to create clear requirements for release documentation. Each project need to be aware of what's expected and this need to be tracked by the release manager.

Suggestion to create a table with projects categorised with associated documentation forming an initinal set of release documentation

@Sofia Wallin

Outdated/not maintained content

In order to keep track of releases and ensure that the documentation is structured well outdated content need to be removed. It is very hard to keep track, support and perform reviews with lots of content that is not longer relevant.

The project suggest to create a wiki page where we keep track outdated links and content that has not been updated during previous releases. This would be a longterm exercise with recurrent sync with the TSC for approval of removing such pages. 

Action points

@Sofia Wallin to invite @David McBride to a doc call to discuss tracking improvements 
@Sofia Wallin to create a wiki page for outdated/old content
@Andreas Geißler & @Thomas Kulik create a suggestion for better tracking release documentation 
@Sofia Wallin map the participating projects list to the tracking page for documentation 
@Sofia Wallin reach out to @Timo Perala for a late addition to the upcoming event. 



Date and Time

Time zone

Date

Time

Participants

Time zone

Date

Time

Participants

CEST

October 14th

16:30-18:30

@Sofia Wallin (moderator)



Logistics:

ONAP3