Uploaded image for project: 'Observability Documentation'
  1. Observability Documentation
  2. OBSDOCS-1319

Update monitoring config map API reference content for OCP 4.17 release

XMLWordPrintable

      After OCP code/feature freeze, update the config map API reference .adoc content from the CMO repo and add the new content to the OCP docs.

      Description of tasks:

      For every release, the Asciidoc content for the Config map reference for the Cluster Monitoring Operator topic must be updated in the core OCP docs. This content is automatically generated from code comments in the CMO source code and aggregated into api.md. For every release, the writer needs to do the following things to update the OCP docs .adoc file:

      1. During dev work for changes and additions to the CMO code, edit any changes or additions to the source code comments that engineers have made in the CMO (work with engineers to scope this work and track it in separate Jira issues).
      2. Diff the changes from the previous release and update the config map reference Asciidoc file (config-map-reference-for-the-cluster-monitoring-operator.adoc) that is included in the core OCP docs. The easiest way to do this is to check out the CMO source code from the Github repository and fetch all the upstream release branches, and then diff the changes in api.md between the previous release branch and the current release branch: run git diff release-4.16 release-4.17 Documentation/api.md locally to show all the new and updated content for api.md between the 4.16 and 4.17 releases of the CMO.
      3. Create a feature branch for the OCP docs repo that incorporates the changes from the diff into the config map reference asciidoc file for the core OCP docs.
      4. Create a PR in the OCP docs repo to add the changes only to the main branch and the branch for the 4.17 release.

       

       

            eromanov@redhat.com Eliska Romanova
            eromanov@redhat.com Eliska Romanova
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: