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

Add missing templates to "Installing a JSF Implementation"

    XMLWordPrintable

Description

    fjuma Has pointed out (during review of the release notes), that several sections in "7.9.1. Installing a JSF Implementation" in the Configuration guide are missing the example templates as are shown in the community docs. Here is the full feedback:

    -----------------------
    I took a look at Section "3.15. JSF" in the release notes. It looks good except for the "Mojarra/MyFaces 2.2.x" section. This section currently mentions that "<module name="org.jboss.as.jsf"/>" should be added to the dependencies in the jsf-injection module. Instead of mentioning this in the release notes, I think it makes more sense to specify this in the Configuration Guide in Section 7.9.1 "Installing a JSF Implementation". In particular, in the sub-section "Add the JSF Injection JAR File", in step 3, the example jsf-injection module.xml templates that were referenced in the community docs [1] are missing. This step should be reworded as follows:

    3. In the JSF_IMPL_NAME-JSF_VERSION subdirectory, add a module.xml file, similar to the Mojarra or MyFaces template examples, as shown below:

    Example Mojarra JSF injection module
    [the example template can be copy/pasted from here: https://gist.github.com/fjuma/30160f0e95ade328253118c706339604 ]

    Example MyFaces JSF injection module
    [the example template can be copy/pasted from here: https://gist.github.com/fjuma/f73b05c3864255e7b10b49f989f0b75e ]

    With the above change, the "Mojarra/MyFaces 2.2.x" section in the release notes can just be removed since the example templates already include "<module name="org.jboss.as.jsf"/>" in the dependencies.

    Related to this, I noticed that the example templates are missing in other parts of Section 7.9.1 (it looks like this came up in JBEAP-12792 [2] as well but it doesn't look like the examples were added properly in all places, only the "Add the JSF Implementation JAR File" sub-section currently has correct example templates):

    1) In sub-section "Add the JSF API JAR File", the links in step 3 are wrong. The correct example templates can be copy/pasted from here:

    Example Mojarra JSF API module: https://github.com/wildfly/wildfly/blob/master/jsf/multi-jsf-installer/src/main/resources/mojarra-api-module.xml
    Example MyFaces JSF API module: https://github.com/wildfly/wildfly/blob/master/jsf/multi-jsf-installer/src/main/resources/myfaces-api-module.xml

    2) In sub-section "Add the commons-digester JAR File For MyFaces", the example template is missing. It can be copy/pasted from here:

    Example MyFaces JSF commons-digester module: https://github.com/wildfly/wildfly/blob/master/jsf/multi-jsf-installer/src/main/resources/myfaces-digester-module.xml

    [1] https://docs.jboss.org/author/display/WFLY/JSF+Configuration
    [2] https://issues.jboss.org/browse/JBEAP-12792
    -----------------------

    Attachments

      Issue Links

        Activity

          People

            rhn-support-ahoffer Andrea Hoffer
            rhn-support-ahoffer Andrea Hoffer
            Jan Kašík Jan Kašík
            Jan Kašík Jan Kašík
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: