Uploaded image for project: 'Hybrid Cloud Infrastructure Documentation'
  1. Hybrid Cloud Infrastructure Documentation
  2. HCIDOCS-625

Create redirects for 4.18 IPI/UPI docs restructuring

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Major Major
    • openshift-4.18
    • openshift-4.18
    • Metal
    • None
    • False
    • Hide

      None

      Show
      None
    • False

      Background

      Previously, UPI docs resided under the directory installing/installing_bare_metal, and the IPI docs resided under the directory installing/installing_bare_metal_ipi. Additionally, there were two different entry points for the UPI docs and IPI docs in the left hand navigation, even though both UPI and IPI are bare metal documents.

      HCIDOCS-590 consolidated these documents, such that the IPI and UPI documents reside under installing/installing_bare_metal where all of the assemblies for the IPI docs reside under installing/installing_bare_metal/ipi and all but one of the UPI assemblies reside under installing/installing_bare_metal/upi such that any external references to these documents for 4.18 and later releases will be broken and likely result in a HTTP 404 error. This would be most apparent if the links were from our console applications or other documentation from other repositories.

      Remedy

      We need to address this situation with redirects until we understand the full scope of what external documents referenced the bare metal documentation at their old locations. 

      As noted, ALL IPI assemblies now reside under installing/installing_bare_metal/ipi such that we need to redirect any links or cross-references to the IPI assemblies from their former location, installing/installing_bare_metal_ipi to their new location installing/installing_bare_metal/ipi.

      For UPI, one of the assemblies DID NOT move, which means we will likely need individual redirects for each UPI assembly. The assemblies that moved from installing/installing_bare_metal to installing/installing_bare_metal/upi are:

      installation-config-parameters-bare-metal.adoc
      installing-bare-metal.adoc
      installing-bare-metal-network-customizations.adoc
      installing-restricted-networks-bare-metal.adoc
      scaling-a-user-provisioned-cluster-with-the-bare-metal-operator.adoc

      The UPI assembly that did not move is:

      installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc

      That is to say that the assembly that did not move requires no redirect. The IPI docs can probably use a wildcard, because all of them moved. The UPI assemblies that did move will likely require explicit redirects.

      Timeline

      This set of redirects for 4.18 and later releases should be done by the time 4.18 is released.

       

       

       

       

       

       

       

              Unassigned Unassigned
              rhn-support-jowilkin John Wilkins
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: