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

Flatten the Distributed tracing docs structure

XMLWordPrintable

    After the merge, double-check that Tempo is successfully found as a search term in the search of docs.redhat.com in response to Pavol's concern in https://github.com/openshift/openshift-docs/pull/92944#issuecomment-2872281643

     

    Work on this Jira immediately after the DT&OTEL 3.5 release.

     

    Remove `(Tempo)` from all Distributed tracing platform (Tempo) headings AND file lines.

     

    Capitalize both words it as Distributed Tracing.

     

    Move the Distributed tracing architecture assembly and update all include and xref statements:
    from observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
    to observability/distr_tracing/distr-tracing-architecture.adoc

     

    Reorganize content in Distributed tracing architecture page to focus on Tempo and to keep the content for Jaeger self-contained so that it can be cut off for the future Jaeger-removing release.

     

    Move the Installing assembly and update all include and xref statements:
    from observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
    to observability/distr_tracing/distr-tracing-tempo-installing.adoc

    Add a header admonition box:

    For installing the deprecated and soon to be removed {JaegerShortName}, see [Installing] in the {JaegerShortName} documentation.

     

    Move the Configuring assembly and update all include and xref statements:

    from observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
    to observability/distr_tracing/distr-tracing-tempo-configuring.adoc

    Add a header admonition box:

    For configuring the deprecated and soon to be removed {JaegerShortName}, see [Configuring] in the {JaegerShortName} documentation.

     

    Move the Troubleshooting assembly and update all include and xref statements:
    from observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc
    to observability/distr_tracing/distr-tracing-tempo-troubleshooting.adoc

     

    Move the Upgrading assembly and update all include and xref statements:
    from observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc
    to observability/distr_tracing/distr-tracing-tempo-updating.adoc

    Add a header admonition box:

    For updating the deprecated and soon to be removed {JaegerShortName}, see [Upgrading] in the {JaegerShortName} documentation.

     

    Move the Removing assembly and update all include and xref statements:
    from observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc
    to observability/distr_tracing/distr-tracing-tempo-removing.adoc

    Add a header admonition box:

    For removing the deprecated and soon to be removed {JaegerShortName}, see [Removing] in the {JaegerShortName} documentation.

     

    Delete the directory observability/distr_tracing/distr_tracing_tempo/.

            rhn-support-mleonov Max Leonov
            rhn-support-mleonov Max Leonov
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: