Uploaded image for project: 'OpenShift Service Mesh'
  1. OpenShift Service Mesh
  2. OSSM-8487 Cut new Doc branch for GA
  3. OSSM-8490

Create a PR into the main OCP doc branch to enable building the new version of the standalone doc on docs.openshift.com

XMLWordPrintable

    • Icon: Sub-task Sub-task
    • Resolution: Done
    • Icon: Normal Normal
    • None
    • None
    • Documentation
    • None

      The PR must change the file named _distro_map.yml in the root directory of the repo. It must create a new branch in the distro that exists for your product.

      Update _distro_map.yml on main branch, adding version info:

      openshift-service-mesh:
        name: Red Hat OpenShift Service Mesh
        author: OpenShift documentation team <openshift-docs@redhat.com>
        site: commercial
        site_name: Documentation
        site_url: https://docs.openshift.com/
        branches:
          service-mesh-docs-3.0.0tp1:
            name: '3.0.0tp1'
            dir: service-mesh/3.0.0tp1
          service-mesh-docs-3.0:
            name: '3.0'
            dir: service-mesh/3.0

      Note that this can be done before GA but will show the docs live on docs.openshift.com to anyone with a direct link. The page will display a "this is not really available yet" banner.

      Merge to Main branch, and ping one of Kathryn Alexander, Aidan Reilly, Gaurav Nelson, Srivaralakshmi Ramani, Mikhail (Misha) Ramendik, or Gabriel McGoldrick in the PR to ask them to review and merge. This can break the build so it must be reviewed.

      Sample PR is here.

      More details are at steps 3-7 here.

              bdooley@redhat.com Brian Dooley
              rhn-support-gmonahan Gwynne Monahan
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: