Virtual Event
This event will be be a virtual hacking session focusing on the Guilin Release. The call with be open xx-xx UTC.
...
Name | Topic/task | Outcome |
---|---|---|
Andreas Geissler |
| Updated our Working Review List (Copy of Guilin Documentation (working version for reviews)) |
Andreas Geissler |
|
|
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 | |
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 Geissler & 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 |
---|---|---|---|
CET | September 30th | 13:00-16:30 | Sofia Wallin (moderator) |
EDT | September 30th | ||
PST | September 30th |
Logistics:
https://zoom.us/j/92987486389?pwd=QUdnMVVjZS83Y0dEalA2Y01UQzhEZz09
Document List (Work in progress for Hackathon):
...
Project Name
...
Document Owner
(name - use @ notation)
...
Current Document State (as of M1)
Choices:
- New
- Maintained
...
Activity Planned for Release
Choices:
- Initial Publication
- Major Update
- Minor Update
- No Change
...
Preliminary Documentation
New docs or new projects ONLY
(enter "N/A" if not applicable, or link to gerrit if completed)
...
Attended Doc Hackathon 1 on <date>
(Document owner must attend at least one hackathon)
(fill in green checkmark if attended)
...
Attended Doc Hackathon 2 on <date>
(Document owner must attend at least one hackathon)
(fill in green checkmark if attended)
...
Reviewed by the doc project (reviewed means release related content. Such as release notes and release name were applicable)
By best effort!
...
M1
...
M2/M3
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Ittay Stern , automatically generated
...
...
...
...
...
...
...
...
...
...
Event Client Documentation Repository
...
...
...
...
...
...
...
...
release notes
API
...
...
...
...
...
...
MOD User guide
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html
https://git.onap.org/doc/log/docs/conf.py
...
...
...
...
...
...
...
...
...
...
...
...
...
...