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

Fix style issues in DT/OTEL docs

XMLWordPrintable

    • OBSDOCS (Mar 25 - Apr 15) #251, OBSDOCS (Apr 15 - May 6) #252

      1. In observability/index.adoc on line 48, add an anchor ID on "For more information, see xref:../otel/otel_rn/otel-rn-3.1.adoc[

      {OTELName}

      ]."

      2. Add an anchor ID to [https://github.com/openshift/openshift-docs/pull/72128/files#diff-f6da205dc13ed82ed5b600db8884af74c390e5879c80f4d1b72984248607968aR39] for main + cherry-picks

      3. Ashleigh: I would remove the product name from as many titles as possible tbh since the docs are already grouped per product in the left nav, and the abstract tends to refer to the product name anyway (https://github.com/openshift/openshift-docs/pull/70943)

      4. Capitalize Operator everywhere in the docs based on[ https://github.com/openshift/openshift-docs/pull/70943#discussion_r1498331517|https://github.com/openshift/openshift-docs/pull/70943#discussion_r1498331517]

      5. Add "instance" after "TempoStack" everywhere (https://github.com/openshift/openshift-docs/pull/70943)

      6. Search and replace in the docs: Ashleigh: There is an attribute for the Elasticsearch {es-op} and Loki {loki-op} Operators now, please use them to maintain consistency (https://github.com/openshift/openshift-docs/pull/70943)

      7. Update all headings in response to Ashleigh's peer review comment in[ https://github.com/openshift/openshift-docs/pull/71565#discussion_r1497971518|https://github.com/openshift/openshift-docs/pull/71565#discussion_r1497971518]

      8. In distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc, "abrennan89 Feb 21, 2024: I don't usually see underscores used in IDs unless it's a specific case (additional resources, prerequisites) so per the guidelines here I'd recommend only using dashes for these[ https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#anchoring-in-assembly-files|https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#anchoring-in-assembly-files] " (https://github.com/openshift/openshift-docs/pull/70943)

      9. Investigate[ https://github.com/openshift/openshift-docs/pull/71565#discussion_r1498058501|https://github.com/openshift/openshift-docs/pull/71565#discussion_r1498058501].

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

              Created:
              Updated:
              Resolved: