-
Story
-
Resolution: Done
-
Medium
-
None
Complete following read-the-docs documentation:
- Release Notes
Use https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/release-notes.html as guide.
Clarify Release version to create and refer to 0.0.x or 1.0.0 ?!No need for 'New Features' section -
- First (and only) block version 0.0.x or 1.0.0
- CPS can be described as just 1 component
- Refer to version 1.0.0 (in DCAEGEN2) as example for new project
- Deliverables, just 1 single image
- Limitations, list current bugs. list 'draft' API methods, 509 response on get '\'
- Fixed Security issues, already in commit https://gerrit.onap.org/r/c/cps/+/118647
- Known security issues. Copy from Sonar Qube report. https://sonarcloud.io/dashboard?id=onap_cps
- Test Results, link to https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases
Pair wise testing (test with E2E Slicing TBC)
- Architecture
- Architecture template pending (mailed Chaker Al-Hakim <chaker.al.hakim@futurewei.com>)
Here is the link to the newly created form: https://wiki.onap.org/display/DW/Component+Documentation+Template
Chaker may still make some tweaks to it based on any feedback I may get from the community.
Please note that the parent folder is a new folder that I have created and is release independent
-
- Use Wiki with proposal (if required https://wiki.onap.org/display/DW/CPS-178+Document+CPS+Architecture) to review frist. Alternatively direct to RST in Gerrit.
- Until we have further requirement architect documentation can be kept to a minimum
- Add a 'CPS concepts' section
- Link to this from offered Apis
- ToineSiebelink will provide proposed content s Wiki
- Offered APIs
- add contact information (Slack channel)
1.
|
Finalize Release Notes | Closed | rishi.chail | |
2.
|
Finalize Architecture Documentation | Closed | rkashapov | |
3.
|
CPS concepts page -RST page | Closed | Toine Siebelink |