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

Improve user and developer documentation

    XMLWordPrintable

Details

    • Epic
    • Resolution: Unresolved
    • Undefined
    • None
    • None
    • None
    • None
    • Monitoring Doc improvements
    • False
    • None
    • False
    • Not Selected
    • NEW
    • To Do
    • NEW
    • 72
    • 72% 72%
    • 0

    Description

      Epic Goal

      • Improve documentation for core developers on how to use the in-cluster stack
      • Create a single starting point for developer focused material
      • Improve user facing documentation for recurring issues and questions.

      Why is this important?

      • The in-cluster stack provides infrastructure to monitor, alert and report telemetry
      • Our users are OpenShift developers that want to make use of said infrastructure.
      • We have most things documented, they are just spread out.
      • Reduce friction in getting core components onboarded
      • We have recurring user requests of even bugs that are caused by unclear expectations

      Scenarios

      1. A developer of a core OpenShift operator wants to expose metrics and send them to telemetry. Where do we send that developer to find all the information they need.
      2. A user wants to develop an expectation how many resources their prometheus will consume.

      Acceptance Criteria

      • ...

      Dependencies (internal and external)

      1. ...

      Previous Work (Optional):

      •  

      Open questions::

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              jfajersk@redhat.com Jan Fajerski
              Junqi Zhao Junqi Zhao
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

                Created:
                Updated: