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

Update Variables to reduce confusion

XMLWordPrintable

    • False
    • False
    • Undefined

      To Do - Update ProductName to SMProductName.

      :ProductName: does not exist in the OpenShift `common-attributes.adoc` file but might be used by another aligned product.

      “The {product-title} attribute provides the context-sensitive name of the relevant OpenShift distribution, for example, "OpenShift Container Platform" or "OKD". The {product-version} attribute provides the product version relative to the distribution, for example "4.9".

      **********************************

      When I first set up the Service Mesh variables, I set the product name variable to Service Mesh.  This came up in a recent comment thread on a Serverless PR.

      https://github.com/openshift/openshift-docs/pull/27660#discussion_r563776971

      I know that this is outside the scope of this PR, but I'm slightly concerned at the use of {ProductName}, which in the core OCP docs normally translates to an OpenShift distro, not Service Mesh.

      @JStickler could you raise this with your team please? We use {ServerlessProductName} so maybe ya'll could update this to something similar for your product?

       

      We should probably change {ProductName} from representing OSSM or Jaeger to representing OpenShift. 

      This would require replacing variables in the OSSM and Jaeger assemblies and modules to replace {ProductName} with {SMProductName} or {JaegerProductName}.  And a similar effort for version numbers.

       

              jstickler Julie Stickler (Inactive)
              jstickler Julie Stickler (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: