Uploaded image for project: 'Observability and Data Analysis Program'
  1. Observability and Data Analysis Program
  2. OBSDA-608

Unify Observability documentation

XMLWordPrintable

    • Icon: Feature Feature
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • 2024Q4
    • None
    • None
    • None
    • False
    • None
    • False
    • Not Selected
    • 0% To Do, 0% In Progress, 100% Done

      Proposed title of this feature request

      The Observability docs team is taking a number of steps to progress the program's OKR 1.3 to Introduce centralized and consistent Observability documentation.

       

      Phase 1

      https://issues.redhat.com/browse/OBSDOCS-686 

      • Change the Monitor heading to Observability on the Red Hat OpenShift Container Platform page on the Customer Portal
      • Relocate the Distributed Tracing docs under the new Observability heading
      • Relocate the Support docs under the existing Getting Started heading
      • Relocate the Scalability docs under the existing Configure heading

      Phase 2

      https://issues.redhat.com/browse/OBSDOCS-699 

      • Create an observability folder
      • Nest the monitoring, logging, and tracing folders under the Observability folder
      • Include other necessary files, folders, and symlinks 
      • Create and store an index.adoc file containing Observability Overview content
      • Create and store a new distro_map.yaml file for openshift-observability
      • Create and store a topic map for observability-docs
      • Update the OCP topic map to create an anchor for Observability
      • Create a new branch for each Observability component that currently follows its own release cadence (e.g. Logging, Distributed Tracing, Network Observability)

              rh-ee-rfloren Roger Florén
              rhn-engineering-rvokal Radek Vokal
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: