Uploaded image for project: 'OpenShift Monitoring'
  1. OpenShift Monitoring
  2. MON-2088

Export alert runbooks to openshift documentation

    XMLWordPrintable

Details

    • Sprint 217, Sprint 218, Sprint 219
    • 0

    Description

      We maintain our alert runbooks in github (https://github.com/openshift/runbooks) and all critical alerts have links to those runbooks.
      For OpenShift installs it would be preferable to link to the official OpenShift documentation.
      This story tracks the coding portion of https://issues.redhat.com/browse/RHDEVDOCS-3477, namely an export script, that converts our markdown runbooks to asciidoc and replaces the urls in our alert rules before a release.

      DoD:

      • A script that produces adoc output, that the docs team can consume easily.
      • Find a URL scheme for the documentation runbooks, that is predictable, so that
      • we can easily replace the URLs in the alert definitions

      Attachments

        Issue Links

          Activity

            People

              jfajersk@redhat.com Jan Fajerski
              jfajersk@redhat.com Jan Fajerski
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: