Uploaded image for project: 'JBoss Enterprise Application Platform'
  1. JBoss Enterprise Application Platform
  2. JBEAP-23170

[7.4.z.GA]: Broken link on Getting Started With JBoss EAP OpenShift documentation

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Major Major
    • 7.4.0.PostGA
    • 7.4.0.PostGA
    • Documentation
    • None

      Hello,

      Reading the operator documentation, I found the following link broken under 6.4. Building an application image using eap-s2i-build templates section:

      1. Import EAP images in OpenShift. For more information, see Importing the latest OpenShift image streams and templates for JBoss EAP XP.

      This link should point out to: https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.4/html/using_jboss_eap_xp_3.0.0/using-the-openshift-image-for-jboss-eap-xp_default#importing-the-latest-openshift-image-streams-and-templates-for-jboss-eap-xp_default

      In addition, I think the documentation should not be talking about the latest image streams. At the moment of writing, they are 3.0.0 XP and the documentation is correct because they are the latest, but as soon as we get XP 4.0.0 out, the links will be obsolete because they are not the latest ones. Moreover, the application example described below should use the same image stream to avoid confusing the reader. If the reader just runs what is described in the documentation, the image streams imported will not match the example (they are XP1 and the image stream imported are the XP3). It can be frustrating because you could end up without knowing what's going wrong and why the example described in the documentation doesn't work.

       

      In the same section, this one should be corrected as well:

      1. Configure the imagestream to receive updates about the changes in the application imagestream and to trigger new builds. For more information, see Configuring periodic importing of imagestreamtags.

      This link does not point to the correct section on the target document, it should be: https://access.redhat.com/documentation/en-us/openshift_container_platform/4.9/html/images/managing-image-streams#images-imagestream-import_image-streams-managing

              shipsing@redhat.com Shipra Singh
              shipsing@redhat.com Shipra Singh
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: