Bug 975470
Summary: | Seam2.3 - doc issues in revision 2.3.0-1 of reference guide | ||
---|---|---|---|
Product: | [Retired] JBoss Enterprise WFK Platform 2 | Reporter: | Tomas Remes <tremes> |
Component: | doc-Seam-Reference-Guide | Assignee: | Sneha <snagarwa> |
Status: | CLOSED CURRENTRELEASE | QA Contact: | Marek Schmidt <maschmid> |
Severity: | medium | Docs Contact: | |
Priority: | unspecified | ||
Version: | 2.3.0 | CC: | ankit, kpiwko, maschmid, mnovotny, tremes |
Target Milestone: | GA | ||
Target Release: | 2.3.0 | ||
Hardware: | Unspecified | ||
OS: | Unspecified | ||
Whiteboard: | |||
Fixed In Version: | Doc Type: | Bug Fix | |
Doc Text: | Story Points: | --- | |
Clone Of: | Environment: | ||
Last Closed: | 2013-07-16 11:33:28 UTC | Type: | Bug |
Regression: | --- | Mount Type: | --- |
Documentation: | --- | CRM: | |
Verified Versions: | Category: | --- | |
oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
Cloudforms Team: | --- | Target Upstream Version: | |
Embargoed: |
Description
Tomas Remes
2013-06-18 14:21:58 UTC
Also, please confirm if all instances of JBoss As should be changed, including examples. @Sneha: I think we should refer to EAP everywhere. Some additional issues found: "14.6.5. Securing Entities" "Note that the method need not perform any action; it is only important that it be annotated correctly:" ---> I think correct is: "... it is only important that it is annotated correctly" "21.1. Using Caching in Seam" In Note box there is following sentence with wrong versions: "The built-in cacheProvider component that uses Infinispan Tree module as JBoss Cache successor is not supported in Seam 2.3.1.Final-redhat-1 as part of Red Hat JBoss Web Framework Kit 2.2.0." There is typo in "To add mutable objects to the cache, read the documentation of the underling caching project to know how to notify the cache of changes to the cache." ---> Missing "y" in underling word. Tomas, What are you suggesting for the following (ref: above description): "1.3.1.4. The view: messages.xhtml The JSF page is a straightforward use of the JSF <h:dataTable> component. Again, nothing specific to Seam." ---> This is not true. In the following code snippet there are used s:link and s:button components, which are the Seam ones. Then in following chapter (1.3.2. How it works) there is described usage of h:commandLink and h:commandButton. This might be confusing. @Sneha: I think you can just remove sentence "Again, nothing specific to Seam." and then replace h:commandLink with s:link and h:commandButton with s:button in the text below. Hey Sneha, thank you for updates. However I can see few more issues. "2.4. Changes in the testing framework" The code snippet for point 4 (meaning the second one taken from booking example) need also update (I didn't notice that for first time, sorry). Please ping me for additional info. "26.2. Configuration" <version>4.2.0.Final-redhat-wfk-1</version> ---> current Hibernate search version is 4.3.0.Final-redhat-wfk-2 "27.1.4. Integrating Seam with your EJB container" "First, we will talk about how the EJB component is transferred to JNDI. To avoid using XML, JBoss Enterprise Application Platform uses..." ---> Missing "Red Hat" before JBoss Enterprise Application Platform. "Assuming that your EJB bean class is deployed in an EAR named myapp, the global JNDI name assigned on the JBoss Enterprise Application Platform" ---> Again missing "Red Hat" "27.6. Deployment in Red Hat JBoss Enterprise Application Platform 6" "JBoss Enterprise Application Platform 6 is the default deployment target for all examples in Seam 2.3 distribution." ---> Again missing "Red Hat" "27.7. Configuring SFSB and Session Timeouts in Red Hat JBoss Enterprise Application Platform 6" "JBoss Enterprise Application Platform 6 has a default session bean timeout of 30 minutes, which is configured ... " ---> Again missing "Red Hat" "33.2.1. Configuration" "... rovided the JBOSS_HOME environment property points to the JBoss Enterprise Application Platform 6 installation." ---> Again missing "Red Hat" Tomas, We are using the 'Red Hat' prefix for the following instances of product names (other than the front page of the guide): 1. in headings 2. first instance in a chapter (Ref: the mailer from Mike Piech about product naming updates) Updated the guide with the first two changes suggested in comment 7. verified, thanks! |