Virtual Event
This event will be be a virtual hacking session focusing on the Guilin Release. The call with be open xx-xx UTC.
...
- Learn more about how to work with documentation
- Guilin specific updates
- Documentation reviews
- <addme>
...
Logistics:
https://zoom.us/j/92987486389?pwd=QUdnMVVjZS83Y0dEalA2Y01UQzhEZz09
Document List (Work in progress for Hackathon):
Project Name | Document Title | RST-File | RTD-Link | Document Owner (name - use @ notation) | Current Document State (as of M1) Choices: | 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) | Link to Final Documentation in ReadTheDocs (stable/guilin branch) | 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 | Post-M4 | RC2 | CLAMP | Architecture | | Maintained | Minor Update | N/A | POLICY | Architecture | | Maintained | Minor Update | N/A | POLICY | Offered APIs | | Maintained | Minor Update | N/A | POLICY | Development Guide | | Maintained | Minor Update | N/A | HOLMES | Architecture | | Maintained | No Change | N/A | HOLMES | Offered APIs | | Maintained | No Change | N/A | HOLMES | Consumed APIs | | Maintained | Minor Update | N/A | HOLMES | Installation | | Maintained | Minor Update | N/A | Modeling | Architecture | | Maintained | Minor Update | N/A | Modeling | Offered APIs | | Maintained | Minor Update | N/A | OOF | Architecture | | Maintained | Minor Update | N/A | OOF | Offered APIs | | Maintained | Minor Update | N/A | OOF | Release Notes | | Maintained | Minor Update | N/A | VFC | Offered APIs | | Maintained | Minor Update | N/A | SO | Architecture | | Maintained | Minor Update | N/A | SO | Offered APIs | | Maintained | Minor Update | N/A | SO | Development Guide | | Maintained | Minor Update | N/A | VID | Release Notes | | Maintained | Minor Update | N/A | VID | Swagger API | ittay , automatically generated | Maintained | No Change | N/A | VID | User Guide | | Maintained | No Change | N/A | Usecase UI | Release Notes | | Maintained | Minor Update | N/A | Usecase UI | User Guide | | Maintained | Minor Update | N/A | Usecase UI | Installation Guide | | Maintained | No Change | N/A | SDC | Architecture | | Maintained | Minor Update | N/A | SDC | Release Notes | | Maintained | Minor Update | N/A | AAI | Offered APIs | | Maintained | Minor Update | AAI | AAI REST API | | Maintained | Minor Update | AAI | Release Notes | | Maintained | Minor Update | Integration | Release Notes | | Maintained | Minor Update | Integration | User Guide including use case documentation | | Maintained | Minor Update | Integration | Test Developer Guide | | New | Initial Publication | MultiCloud | Architecture | | Maintained | No Change | N/A | MultiCloud | RESP API | | Maintained | No Change | N/A | MultiCloud | User Guild | | Maintained | No Change | N/A | ONAP CLI | Release notes | | Maintained | Minot updates | N/A | VNFSDK | release notes API | | Maintained | Minot updates | N/A | DCAE | Architecture | | Maintained | Minor Update | DCAE | Release Notes | | Maintained | Minor Update | DCAE | Offered API's | | Maintained | Minor Update | DCAE | Consumed API's | | Maintained | Minor Update | DCAE | MOD User guide | | Maintained | Minor Update | DCAE | DCAE Service Components | | Maintained | Minor Update on existing components + new Guilin components | VVP | VVP Documentation | | Maintained | Minor Update | N/A | VNFRQTS | Provider Docs | | Maintained | Minor Update | DMAAP | Architecture and Usage | | Maintained | No Change | N/A | DMAAP | Release Notes | | Maintained | Minor Change | N/A | PORTAL | Release Notes | | Maintained | Major Update | N/A | CCSDK | CDS User Guide | | Maintained | Minor update | N/A | CCSDK | Release Notes | | Maintained | Minor update | N/A | SDNC | Offered APIs | | Maintained | Minor Update | SDNC | Release Notes | | Maintained | Minor Update | N/A | DOC | Release Notes | Name | Topic/task | Outcome |
---|
| - 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
|
Date and Time
...
Sofia Wallin (moderator)
...
release-notes.rsthttps://docs.onap.org/en/latest/release/index.html | | Maintained | Minor Update | N/A | DOC | Landing page | https://git.onap.org/doc/tree/docs | https://docs.onap.org/en/latest/index.html | | Maintained | Minor Update | N/A | DOC | Composite release note | https://git.onap.org/doc/tree/docs/release | https://docs.onap.org/en/latest/release/releaserepos.html#doc-releaserepos | | Maintained | Minor Update | N/A | DOC | ONAP User Guides | https://git.onap.org/doc/tree/docs/guides/onap-user | https://docs.onap.org/en/latest/guides/onap-user/index.html | | Maintained | Minor Update | N/A | DOC | ONAP Operation Guides | https://git.onap.org/doc/tree/docs/guides/onap-operator | https://docs.onap.org/en/latest/guides/onap-operator/index.html | | Maintained | Minor Update | N/A | DOC | RST Templates | https://git.onap.org/doc/tree/docs/templates | Sofia Wallin | DOC | DOC Developer Guide | https://git.onap.org/doc/tree/docs/guides/onap-developer/how-to-use-docs | https://docs.onap.org/en/latest/guides/onap-developer/how-to-use-docs/index.html | | DOC | API Reference | https://git.onap.org/doc/tree/docs/guides/onap-developer/apiref | https://docs.onap.org/en/latest/guides/onap-developer/apiref/index.html | | DOC | ONAP Tutorials | https://git.onap.org/doc/tree/docs/guides/onap-developer/tutorials | https://docs.onap.org/en/latest/guides/onap-developer/tutorials/index.html | ? | DOC | ONAP Component Document Index | https://git.onap.org/doc/tree/docs/guides/onap-developer/developing | https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html https://git.onap.org/doc/log/docs/conf.py | | DOC | ONAP Architecture | https://git.onap.org/doc/tree/docs/guides/onap-developer/architecture | https://docs.onap.org/en/latest/guides/onap-developer/architecture/index.html | | DOC | ONAP Overview | https://git.onap.org/doc/tree/docs/guides/overview | https://docs.onap.org/en/latest/guides/overview/index.html | ? | OOM | Setup Guide | | Maintained | Minor Update | N/A | OOM | Release Notes | | Maintained | Minor Update | N/A | EXTAPI | Architecture | | Maintained | No Change | N/A | EXTAPI | Offered APIs | | Maintained | Minor Update | N/A | EXTAPI | Consumed APIs | | Maintained | Minor Update | N/A | EXTAPI | Installation | | Maintained | No Change | N/A | EXTAPI | Developer Guide | | Maintained | No Change | N/A | MSB | Architecture | | Maintained | No Change | N/A | MSB | Offered APIs | | Maintained | No Change | N/A | MSB | Consumed APIs | | Maintained | No Change | N/A | Installation | | Maintained | No Change | N/A | - Put to TSC agenda to come up with a Release strategy.
- Add for each project a release branch,....
|
| 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 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 |
---|
CET | September 30th | 13:00-16:30 | |
EDT | September 30th |
| |
PST | September 30th |
| |
Logistics:
https://zoom.us/j/92987486389?pwd=QUdnMVVjZS83Y0dEalA2Y01UQzhEZz09