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

[7.1] EAP for OpenShift (and Online) Guide Revamp

XMLWordPrintable

      Suggestions from the docs minimalism workshop to improve the EAP for OpenSHift Guides (including EAP for OpenShift Online):

      • The meaning/point behind Chapter 1: Introduction seems to be confused. It seems to be talking about EAP and what it is and what it does. Should it be introducing the concept of this guide?
      • Section 1.5 Persistent Templates seems lost. If this is a section describing an EAP standard, it should discuss this in a more obvious place. Is it more a reference?
      • Is "Installation and Configuration" the best title for Chapter 2? This seems to be the way to way to set up a project with EAP running on OpenShift.
      • A "Prerequisites" section would be a good idea for the information in Chapter 2.
      • 2.1 'Overview' doesn't make any sense.
      • Section 2.2 Key Terms doesn't add anything (except for 'secrets'), and is barely about either OpenShift or EAP terms. Is suggest it be removed.
      • All of the 2.4 sections are single steps in one big procedure. Can this be altered to be more together? Perhaps one big procedure, rather than separate procedures?
      • There was talk about 2.4.6 and how this was a strange procedure in the "how does s2i work?" sense. Do these need to be tested to make sure they are portraying the step accurately? Verification step?
      • Maybe consolidate the whole 'tutorial' section in chapter 3 to be the main part procedure in chapter 2.

            lcosti.redhat Lucas Costi (Inactive)
            lcosti.redhat Lucas Costi (Inactive)
            Tomas Remes Tomas Remes
            Tomas Remes Tomas Remes
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Created:
              Updated:
              Resolved: