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

Publish service mesh docs to ROSA

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Major
    • OSSM 2.3.0
    • None
    • Documentation
    • None

    Description

      Publish Service Mesh docs to Red Hat OpenShift Service on AWS (ROSA)

      ROSA Topic Map restructure (WIP) https://github.com/openshift/openshift-docs/pull/41923

       

      We currently support OSSM 2.0+ as an unmanaged addon (ie same as we do for OCP) on:

      • Azure Red Hat OpenShift (ARO     (OSSM-421)
      • Exception: federation (OSSM-693)

      TASK here is now to add to Service Mesh entries to the{{ _topic_maps/_topic_map_rosa.yaml}} file to publish service mesh content to the ROSA output.

      Will ALSO need to identify prerequisites that mention installing on OpenShift and apply conditions to hide that content in OSD and ROSA  (since customers will NO need to install OpenShift)

      How to conditionalize content -? https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#conditional-content

       

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

      E-mail from Vikram 11/17/21 Subject "Upcoming major change to the build format for OpenShift documentation"
      In order to support distribution based topic maps, asciibinder [2], our underlying build tool, will be upgraded in our docs pipeline on docs.openshift.com on Tuesday, 23rd Nov. The major change with this upgrade is the migration of the _topic_map.yml in the root folder to a _topic_maps folder. This will impact all open PRs that touch the current topic_map.
       
      This change in asciibinder will enable us to single source content for our OpenShift Dedicated and ROSA distributions more effectively and efficiently than before (more details to follow).
       
      If all goes well, any open PRs will need to be rebased, and use the topic_map from the new location.
       
      During this migration (on 23rd Nov), it is requested that you do not open any new PRs against the openshift-docs repository. It is also recommended that you try and merge as many open PRs as you can before this upgrade.
       
      This migration of topic map to a folder will only be done for supported 4.x stream versions (4.6+). The upgrade is backwards compatible, so non supported versions will not be migrated (but will still work).

       

      Attachments

        Issue Links

          Activity

            People

              rhn-support-tokeefe Tim O'Keefe
              jstickler Julie Stickler (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: