Uploaded image for project: 'OpenShift Service Mesh'
  1. OpenShift Service Mesh
  2. OSSM-3102

Determine what to do with unused tutorial files

    XMLWordPrintable

Details

    • False
    • None
    • False

    Description

      When cleaning out unused files in the repo, I found that we had two tutorial modules with several associated graphics files that were not being published (that is, they are not included in any assembly or listed in the Topic Map file).

      I wasn't sure if these might be topics that we wanted to restore to the documentation, if only to create sections where we talk about Prometheus and Grafana.  I know that there are items in the backlog related to Prometheus, so it might be useful to create a section of the docs for Prometheus content.  I'm less sure about the need for the Grafana topic or how much future documentation there might be for Grafana?

      The unused files are the following:

      • modules/ossm-tutorial-grafana-acessing.adoc
        • images/ossm-grafana-home-screen.png
        • images/ossm-grafana-mesh-no-traffic.png
        • images/ossm-grafana-mesh-with-graffic.png
        • images/ossm-grafana-services.png
        • images/ossm-grafana-workloads.png
      • modules/ossm-tutorial-prometheus-querying-metrics.adoc
        • images/ossm-prometheus-home-screen.png
        • images/ossm-prometheus-metrics.png

       

       

      Attachments

        Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. OSSM-3169 Missing Documentation for setting CPU/Memory requests/limits to OSSM components(Jaeger, Kiali,Grafana)

          • Normal - To be worked after urgent and high priorities are resolved. This term is chosen when the severity of an issue is relatively close to the level of effort to fix it. The existence of an easily implemented workaround can also lead to this priority level instead of a higher priority.
          • Closed

          Task - Represents a small unit of work that is not end-user facing. OSSM-3184 [DOC] [Kiali] Integration config (Prometheus, Jaeger, Grafana)

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed

          Task - Represents a small unit of work that is not end-user facing. OSSM-3178 [DOC] Add Prometheus tuning upstream docs to downstream

          • Minor - To be worked after urgent, high, and medium priorities are resolved. This term is chosen when the severity of the issue is low, or the complexity or effort to correct it may be higher, relatively speaking. For low priority issues, known workarounds exist or are not needed due to the trivial effort needed to address the issue.
          • Closed

          Activity

            People

              Unassigned Unassigned
              jstickler Julie Stickler (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: