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

Feedback from EAP 7.1 alpha release notes peer review

    XMLWordPrintable

Details

    • Release Notes

    Description

      Did a peer review of the EAP 7.1 alpha release notes and have the following comments/suggestions.

      1. "It is based on Wildfly 10"
        • I believe EAP 7.1 will be based on WildFly 11, but suggest removing this statement completely for now, since WildFly 11 isn't out yet. That's what I did for the Getting Started Guide.
      2. "Red Hat JBoss Enterprise Application Platform 7.1 (JBoss EAP 7)"
        • Suggest "Red Hat JBoss Enterprise Application Platform 7.1 (JBoss EAP 7.1)"
      3. Instances of Management Console and Management CLI should be lowercase.
      4. "Updating Attributes in the Management Console section of the JBoss EAP Configuration Guide."
        • This entire text should not be in the link. The link text should just be "Updating Attributes in the Management Console"
      5. "pre-configured" -> "preconfigured"
      6. "see the Red Hat JBoss Middleware Product Update and Support Policy article"
      7. "see the JBoss Enterprise Application Platform Component Details"
      8. "or by use an earlier version" -> "or use an earlier version"
      9. "to server-group and host" -> "to server group and host"
      10. "command line interface" -> "command-line interface"
      11. "can hide information that while it is" -> "can hide information that, while it is"
      12. "not related to the server-groups" -> "not related to the server groups"
      13. "This is distinct from"
        • I don't think this is the right way to use the word "distinct". Suggest finding a better word ("different"?) or rephrasing.
      14. "profile, socket binding group, deployment, deployment override, server group, server config and server"
        • The items in this list are backticked, to mean literal values in the management model. However some of them need to be hyphenated then: deployment-override, server-group, server-config, socket-binding-group
      15. "Depending on the attribute type, the input field can be a text field, checkbox, or drop down."
        • This was pulled from the config guide, but the context doesn't really make sense here. Suggest removing this sentence and starting with "In some text fields in the management console, as you type, values from elsewhere in the configuration may appear as suggestions."
      16. "The attributes shown in JBoss EAP 7.0.0 management console but not any more in EAP 7.1. management console."
        • "JBoss EAP 7.0.0" -> "JBoss EAP 7.0"
        • "EAP 7.1." -> "JBoss EAP 7.1"
        • This isn't actually a full sentence. Look at reworking.
      17. The main items in bold are not consistently title case or non-title case
      18. In the "Unsupported Features" section, "Messaging (ActiveMQ Artemis)" is listed as a bullet, which makes it seem like it isn't supported. It's really just the subbullet that is unsupported.
      19. The items in the new features section don't actually look to be anything super interesting for customers. Are there other features, available for the alpha release, that should be included to interest new users? Also maybe consider at least mentioning Elytron here, even if you point to the tech preview section for the details.

      Attachments

        Activity

          People

            dmichael@redhat.com David Michael (Inactive)
            rhn-support-ahoffer Andrea Hoffer
            Nikoleta Ziakova Nikoleta Ziakova (Inactive)
            Nikoleta Ziakova Nikoleta Ziakova (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: