Uploaded image for project: 'ONAP Operations Manager'
  1. ONAP Operations Manager
  2. OOM-2995

improve release notes in oom projects

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: High High
    • Kohn Release
    • Jakarta Release
    • None
    • Hide

      The current situation in three OOM projects which are contributing to ReadTheDocs documentation is quiet different:

          • oom ***

      FILE1: https://git.onap.org/oom/tree/docs/release_notes/release-notes-isntanbul.rst

      ! no "release-note.rst" file
      ! typo in used file name
      ! missing release note for jakarta release

          • oom/offline-installer ***

      FILE1: https://git.onap.org/oom/offline-installer/tree/docs/CHANGELOG.rst

      ! no "release-notes.rst" file
      ! changelog does not contain release name
      ! changelog has no intersphix label ".. _release_notes:" which can be used to reference file

          • oom/platform/cert-service ***

      FILE1: https://git.onap.org/oom/platform/cert-service/tree/docs/sections/change-log.rst
      File2: https://git.onap.org/oom/platform/cert-service/tree/docs/sections/release-notes.rst

      ! information split into two files
      ! release note does not contain release name

       

      Can you please ...

      • migrate information from the change-logs into release notes (and remove change-logs)
      • use {}one_{_} file per project which holds the the release information and name the file "release-notes.rst" (it would be good not to include the release name in the file name - so we do not have to change references from release to release)
      • include the label ".. _release_notes:" in every "release-notes.rst" file to enable proper intersphinx references

      That would be awesome!

      In case of questions do not hesitate to contact me.

      Show
      The current situation in three OOM projects which are contributing to ReadTheDocs documentation is quiet different: oom *** FILE1: https://git.onap.org/oom/tree/docs/release_notes/release-notes-isntanbul.rst ! no "release-note.rst" file ! typo in used file name ! missing release note for jakarta release oom/offline-installer *** FILE1: https://git.onap.org/oom/offline-installer/tree/docs/CHANGELOG.rst ! no "release-notes.rst" file ! changelog does not contain release name ! changelog has no intersphix label ".. _release_notes:" which can be used to reference file oom/platform/cert-service *** FILE1: https://git.onap.org/oom/platform/cert-service/tree/docs/sections/change-log.rst File2: https://git.onap.org/oom/platform/cert-service/tree/docs/sections/release-notes.rst ! information split into two files ! release note does not contain release name   Can you please ... migrate information from the change-logs into release notes (and remove change-logs) use { }one_{_} file per project which holds the the release information and name the file "release-notes.rst" (it would be good not to include the release name in the file name - so we do not have to change references from release to release) include the label ".. _release_notes:" in every "release-notes.rst" file to enable proper intersphinx references That would be awesome! In case of questions do not hesitate to contact me.

          andreasgeissler Andreas Geissler
          thmsdt Thomas Kulik
          Votes:
          0 Vote for this issue
          Watchers:
          1 Start watching this issue

            Created:
            Updated:
            Resolved: