Uploaded image for project: 'Configuration Persistence Service'
  1. Configuration Persistence Service
  2. CPS-266

Finalize Honolulu Documentation

XMLWordPrintable

      Complete following read-the-docs documentation:

      1. 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
        1. First (and only) block version 0.0.x or 1.0.0
        2. CPS can be described as just 1 component
        3. Refer to version 1.0.0 (in DCAEGEN2) as example for new project
        4. Deliverables, just 1 single image
        5. Limitations, list current bugs. list 'draft' API methods, 509 response on get '\'
        6. Fixed Security issues, already in commit https://gerrit.onap.org/r/c/cps/+/118647
        7. Known security issues.  Copy from Sonar Qube report. https://sonarcloud.io/dashboard?id=onap_cps
        8. Test Results, link to https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases
          Pair wise testing (test with E2E Slicing TBC)
      2. Architecture
        1. 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

        1. 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.
        2. Until we have further requirement architect documentation can be kept to a minimum
        3. Add a 'CPS concepts' section
          1. Link to this from offered Apis
          2. ToineSiebelink will provide proposed content s Wiki
      1. Offered APIs
        1. add contact information (Slack channel) 

       

       

            ToineSiebelink Toine Siebelink
            ToineSiebelink Toine Siebelink
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: