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

[Jupiter] Merge attributes files

XMLWordPrintable

      Service Mesh and distributed tracing currently have their own attributes files, for variables such as product name, version, operator name, etc. 

      For Jupiter these files have already been moved out of the `modules` folder and into the `_attributes` folder in the repo structure.  The next step is to merge our separate attributes files into the `common-attributes.adoc` file.

      E-mail from Kathryn Alexander  Mar 18, 2022
      You're one of the owners of an attributes file that needed more investigation before its values could be transferred into the common-attributes.adoc file. You need to remove unused attributes, make duplicate attribute names unique, and transfer your attributes to the common-attributes file. If you can't (or don't want to) complete the attribute transfer by 4/1, please let me know ASAP.
       
      Because of the way Jupiter's build process supplies attribute values, each attribute name and value that Jupiter uses must be unique. Jupiter will use the vast majority of the attributes, and it will apply them to the files in the order that they are placed in the attributes file. (Attribut
       
      Your attribute files assert that some attributes, like :DocInfoProductName: and :RN_BookName:, drive values in the master.adoc or master-doc.xml files. These artifacts are only used when publishing content to PV1. I looked through the gitlab repo, and the values of this type of attribute are not propagating to the PV1 publication artifacts. We can remove the attributes that are not used in assemblies or modules and rename the remaining attributes.
       
      However, because of the way asciibinder distributes attribute values, it is acceptable to encode alternate attribute values in conditionals that only asciibinder will process. (Using if statements to define alternate values for OKD works as expected as long as the OKD value is placed after the OCP value.)
       
      There are some other duplicate attribute names, but you can replace them with whatever unique name you like.

      ~~~
      Here's how I'd approach the changes:
       
      1. If you're using one of these attributes just because you think it's doing something in PV1 or because a template told you to assign it, delete it:
      :DocInfoProductName:
      :DocInfoProductName:
      :DocInfoProductNumber: 
      :RN_BookName:
      :Install_BookName:
      :Using_BookName: 

      2. If you're using an attribute that's already defined in the common-attributes.adoc file:

      • If your attribute value matches the value in the common-attributes.adoc file, delete your attribute.
      • If your attribute value is different from what's already in the common-attributes.adoc file, rename your attribute and apply the new attribute name to your files.

      3. If you're using an attribute name in more than one of your attribute files or one of the ones that was supposed to have a function in PV1, use a different, unique attribute name in the attributes file, assemblies, and modules.

      4. Add a comment to the common-attributes file that describes your area and place your remaining attributes beneath it. If you use OKD values, be sure to put them last.

      5. Make sure that the common-attributes.adoc file is included in all of your assemblies one time, and remove all references to your other attribute files.
       
      6. Delete your attribute file.
       

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

              Created:
              Updated:
              Resolved: