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

Address multi-dimensional version confusion

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Minor Minor
    • OSSM 2.3.0
    • OSSM 2.0.0, OSSM 2.1.0
    • Documentation
    • None

      This is a related and potentially duplicate issue: https://issues.redhat.com/browse/OSSMDOC-176.

       OpenShift Service Mesh effectively has 3 dimensions of versioning (in the order a user is likely to discover them):

      • Operator versioning (a source of much confusion upon the release of 2.0 as operators are set to auto-upgrade by default)
      • ServiceMeshControlPlane version (Currently supported: 2.0, 1.1)
      • Service Mesh API/Resource Versioning (v1, v2) - both are supported in 2.0 (1.0?)

      For the operator versioning, there is not a large documentation dependence, although this should be explained in the installation page.

      For the ServiceMeshControlPlane version, it roughly aligns with the two sets of documentation we have (Service Mesh 2.x, Service Mesh 1.x). Having separate sets of docs creates confusion when linking, and causes documentation maintenance headache.

      Service Mesh resource versioning is perhaps the most challenging. This mostly impacts example YAML definitions scattered throughout the doc. In some cases, such as the Custom Resource page (which should be moved to customizing the installation), v1 and v2 of the resource are seemingly randomly used throughout the page: https://docs.openshift.com/container-platform/4.6/service_mesh/v2x/ossm-custom-resources.html. Some documentation tooling offers the ability to have examples for different versions, which could be one possibility.

      rhn-support-hjoy I created this as one issue, but I believe we discussed creating two - we can discuss splitting it.

       

       

              jstickler Julie Stickler (Inactive)
              jlongmui@redhat.com Jamie Longmuir
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: