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

Update Distributed Tracing doc links and topic map position

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Test Pending
    • Icon: Blocker Blocker
    • Distributed Tracing 3.1
    • Distributed Tracing 3.1
    • Meta
    • None
    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • OBSDA-608 - Unify Observability documentation
    • OBSDOCS (Dec 4 - Dev 25) #246, OBSDOCS (Jan 1 - Jan 22) #247, OBSDOCS (Jan 22 - Feb 12) #248, OBSDOCS (Feb 12 - Mar 4) #249, OBSDOCS (Mar 4 - Mar 25) #250

      Perform to following tasks: 

      • Modify _topic_map.yaml to move Distributed Tracing under Observability
      • Search the whole docs set and replace all old occurrences of the file(s) with the new location, paying special attention to anchor tags.
      • Update incoming/outgoing xrefs to reflect the change to the relative path (../)
      • Run asciibinder build to confirm that the changes are correct locally. Fix any errors.
      • Confirm that the topic is not used by the console by reviewing this file. If it is used by the console team, reach out to the OCP DPM.
      • If redirects need to be set up, follow these steps in advance of merging your PR.
      • Apply these changes to OCP 4.12+

      In the topic map, initial doc headings for each component occur at the same level as the Observability overview. The Distributed Tracing entry goes before the Power Monitoring docs. 

      The docs in the Observability directory will ultimately be ordered in the following way: 

      Monitoring

      Logging 

      Distributed Tracing

      Red Hat build of OpenTelemetry

      Network Observability 

      Power Monitoring

            rhn-support-mleonov Max Leonov
            rhn-support-lfrazier Lindsey Frazier (Inactive)
            Brian Dooley
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: