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

Fix typos discovered by Claude analysis of monitoring docs

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • None
    • Monitoring
    • None
    • 3
    • False
    • Hide

      None

      Show
      None
    • False

      Issues to fix:

      Incomplete Copyright Notices

      • File: `configuring-core-platform-monitoring.md`, `configuring-user-workload-monitoring.md`, `monitoring-key-concepts.md`
        -Current: "Copyright © Red Hat."
        -Should be: "Copyright © 2025 Red Hat, Inc."
        and 
      • Issue: Contains "Red Hat Software Collections" reference which is inconsistent with other files in the collection

      --> check why these legal notices are rendered incorrectly 

      Formatting Inconsistencies

      • File: `configuring-core-platform-monitoring.md`
        -Issue: "collectionProfile: minimal" contains bold markdown formatting instead of plain text
      • File: `configuring-user-workload-monitoring.md`
        -Issue: Extra space in "can be configured ," should be "can be configured,"

      Additionally, check with the eng team to assess the other two discovered errors:

      Inconsistent Product Naming

      • File: `accessing-metrics.md`
      • Issue: References "Red Hat OpenShift Service on AWS projects" when it should be "Red Hat OpenShift Container Platform projects" for consistency with the rest of the documentation
        --> check with engineering

      Type Name Inconsistency

      • File: `config-map-reference-for-the-cluster-monitoring-operator.md`
      • Issue: Description says "OpenShiftMetricsConfig" but should be "OpenShiftStateMetricsConfig" to match the actual type name

       

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

                Created:
                Updated: