-
Task
-
Resolution: Test Pending
-
Blocker
-
Distributed Tracing 3.1
-
None
-
3
-
False
-
-
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
- clones
-
OBSDOCS-692 Update Monitoring doc links and topic map position
- Closed
- depends on
-
OBSDOCS-886 Create Observability directory for OCP 4.12+
- Closed
-
OBSDOCS-643 Organize all OBS component docs under an Observability heading on the Portal
- Closed
-
OBSDOCS-689 Update OCP topic map with Observability dir
- Closed
- is cloned by
-
OBSDOCS-716 Update OpenTelemetry doc links and topic map position
- Closed
- is incorporated by
-
OBSDOCS-858 Distributed Tracing 3.2 Docs Epic
- Closed
- links to