Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-76497

Document ack-4.18-gateway-api-management-in-4.19 ack

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • 4.19
    • None
    • None
    • False
    • Hide

      None

      Show
      None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Description of problem

      NE-1951 taught the 4.18 ingress operator about an ack-4.18-gateway-api-management-in-4.19 admin ack. The message for that ack links a release-note section. OSDOCS-5036 added that release note, linking to the Preparing for Gateway API management succession by the Ingress Operator section. However, the link anchor is currently:

      $ curl -s https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/release_notes/ocp-4-19-release-notes | grep -o '"[^"]*#[^"]*manage[^"]*succession[^"]"'
      "https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html-single/updating_clusters/#nw-ingress-gateway-api-manage-succession\"
      

      which doesn't quite match the actual anchors on the target page:

      $ curl -sL https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html-single/updating_clusters/ | grep -o ' id="[^"]*manage[^"]*succession[^"]*"' | uniq
       id="nw-ingress-gateway-api-manage-succession_updating-cluster-prepare"
      

      And even then, the target section doesn't wrap up with details on how to apply the ack once the admin is ready to do so:

      $ git grep ack-4.18-gateway-api-management-in-4.19 origin/enterprise-4.19 -- | wc -l
      0
      

      Version-Release number of selected component

      4.19 docs linked from the 4.18 ingress operator.

      How reproducible

      Every time.

      Steps to Reproduce

      1. Start from https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/release_notes/ocp-4-19-release-notes#ocp-4-19-networking-gateway-api-crd-lifecycle_release-notes
      2. Get walked through how to understand the shift in Gateway API CRD management.

      Actual results

      Broken anchor makes Gateway API CRD management section harder to find, and nothing in that section explains how to apply the ack-4.18-gateway-api-management-in-4.19 when you're ready.

      Expected results

      Docs are easy to follow, and explain how to apply the ack-4.18-gateway-api-management-in-4.19 ack when you're ready.

      Additional info

      See here for example docs around applying a different admin ack, in case that's helpful for pattern-matching.

              ocp-docs-bot OCP DocsBot
              trking W. Trevor King
              None
              None
              Hongan Li Hongan Li
              None
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: