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

Phase 2: Standalone Observability Docs

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Duplicate
    • Icon: Undefined Undefined
    • None
    • None
    • Meta
    • None
    • Phase 2: Standalone Observability Docs
    • False
    • Hide

      None

      Show
      None
    • False
    • To Do
    • OBSDA-608 - Unify Observability documentation
    • OBSDA-608Unify Observability documentation
    • 50% To Do, 0% In Progress, 50% Done

      The Observability docs team is taking a number of steps to redirect Observability components to their own standalone docs pages

      Phase 2: Create a landing page/splash page for Observability

      Perform the following tasks in the OCP GitHub repo:

      • 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)

      Perform the following tasks in the OCP Layered Products GitLab repo: 

      • Add the project to the sync.yaml file

      Perform the following tasks in Pantheon:

      • Create a doc splash page for Observability
      • Create a doc splash page for each Observability component per the brand-approved naming scheme

              Unassigned Unassigned
              rhn-support-lfrazier Lindsey Frazier
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: