Uploaded image for project: 'OpenShift Service Mesh'
  1. OpenShift Service Mesh
  2. OSSM-5904

"Troubleshooting your service mesh" has a typo: 'm' should be a comma

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Undefined Undefined
    • None
    • None
    • Documentation, Maistra
    • None
    • False
    • Hide

      None

      Show
      None
    • False
    • Low

      Description of problem

      The "Troubleshooting your service mesh" documentation has a tiny typo: "objectsm" should be "objects,".

      Additionally, I believe there should be an additional comma in the text: "All Istio CRD objectsm such as VirtualServices in a given namespace" should be written "All Istio CRD objects, such as VirtualServices, in a given namespace", using commas to mark that "such as VirtualServices" is a parenthetical phrase.

      Version-Release number of selected component (if applicable)

      4.11 and all later versions.

      How reproducible

      100%.

      Steps to Reproduce

      1. Read <https://docs.openshift.com/container-platform/4.13/service_mesh/v2x/ossm-troubleshooting-istio.html#ossm-about-collecting-ossm-data_troubleshooting-ossm>, or search for "objectsm".

      Actual results

      The documentation has a typo: "All Istio CRD objectsm such as VirtualServices in a given namespace".

      Expected results

      The text should read as follows: "All Istio CRD objects, such as VirtualServices, in a given namespace".

      Additional info

      The module with the typo, https://github.com/openshift/openshift-docs/blob/0c170bb6d97a9cf94073d33763ee594b90df3150/modules/ossm-about-collecting-ossm-data.adoc, has an AsciiDoc comment that seems to specify an inaccurate list of assemblies that include the module (see the raw view of the file to see the AsciiDoc comment):

      // Module included in the following assemblies:
      //
      // * service_mesh/v1x/servicemesh-release-notes.adoc
      // * service_mesh/v2x/servicemesh-release-notes.adoc
      

      The module is actually included in the following 3 assemblies:

      % git --no-pager -C ~/src/github.com/openshift/openshift-docs grep -e 'ossm-about-collecting-ossm-data.adoc'
      service_mesh/v1x/servicemesh-release-notes.adoc:include::modules/ossm-about-collecting-ossm-data.adoc[leveloffset=+2]
      service_mesh/v2x/ossm-support.adoc:include::modules/ossm-about-collecting-ossm-data.adoc[leveloffset=+1]
      service_mesh/v2x/ossm-troubleshooting-istio.adoc:include::modules/ossm-about-collecting-ossm-data.adoc[leveloffset=+2]
      

              rhn-support-gmonahan Gwynne Monahan
              mmasters1@redhat.com Miciah Masters
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: