Attachment 916038 Details for Bug 1116809 – Required fixes for getting started guide

Required fixes for getting started guide

docs-check.txt (text/plain), 6.43 KB, created by Martin Gencur on 2014-07-07 11:05:37 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Martin Gencur

Created: 2014-07-07 11:05:37 UTC

Size: 6.43 KB

patch

obsolete

>* 1.1. Supported Configurations
>
>- the link needs an update
>
>* 1.2. Components and Versions
>
>- the link needs an update
>
>* â 1.5. Red Hat JBoss Data Grid Version Information
>
>There was a real Infinispan release for each JDG version until 6.2.0. However, JDG 6.3 is not based on any specific Infinispan
>release. Version "Infinispan 6.1.0" hasn't been released and it's just an internal versioning. Maybe ve should mention that since JDG 6.3
>there's no corresponding Infinispan release.
>
>* â Chapter 4. Using JBoss Data Grid with Supported Containers
>
>Bullet "An application server, such as JBoss EAP, which provides JBoss Data Grid as a service." is not correct.
>Did you mean running the standalone JDG server? If so, the sentence could be e.g.:
>"As a standalone JBoss Data Grid server."  
>
>* 4.1. Deploy JBoss Data Grid in JBoss EAP (Library Mode)
>
>Bullet "Add a dependency via Maven" should be changed to "Generate the MANIFEST.MF file via Maven"
>(adding a dependency via Maven means somethin different and users might get confused)
>
>The dependencies for CDI should be: Dependencies: org.infinispan:jdg-6.3 services, org.infinispan.cdi:jdg-6.3 meta-inf
>
>
>â * 4.4. Deploy Web Applications on WebLogic Server (Library Mode)
>
>   - Procedure 4.1., step 1) The following sentence is IMO redundant and incorrect: "If the Infinispan CDI module is used, add the infinispan-cdi library and if the JDBC cache store is used, add the infinispan-cachestore-jdbc library in the WEB-INF folder."
>                       We should remove this sentence.
>                     step 3) We should not mention those two libraries (cdi and jdbc cachestore) and rather provide a general info like this:
>                     "Create a web application archive (WAR) file of the web application and verify that the JBoss Data Grid libraries are in the WEB-INF folder along with the WebLogic deployment descriptor file."
>                     step 4) The paragraph should be changed. We need to mention which patch users need to apply. The paragraph could look like this:
>                     "If the web application uses CDI integration, the following patch for the WebLogic server needs to be applied first: <link to the patch> (for more information about applying patches to the WebLogic Server, see the WebLogic Server documentation on the Oracle website)"
>
>* 4.5. Deploy Web Applications on WebLogic Server (Remote Client-Server Mode)
>
>   Procedure 4.2, step 3) This step needs to be changed in the following way (precisely this way, nothing more, nothing less):
>   "
>   Create a web application and add the following libraries as dependencies if Maven is used. 
>   * infinispan-commons
>   * infinispan-client-hotrod
>   "
>
>   (the dependencies must not end with .jar because we're talking about maven dependencies and not just simple jars. 
>   Maven dependencies then have transitive dependendencies which are required as well. If you place .jar there, it means no other libraries
>   are required which is wrong! Also, the commons-pool is a transitive dep of infinispan-client-hotrod so we don't need to mention it.)
>   
>* â 4.6.1. Running a Deployment of JBoss Data Grid in Karaf (Remote Client-Server)
>
>The second paragraph should be slightly changed (we should mention that the path is in JDG maven reposotiry and that we need additional "feature":
>JBoss Data Grid includes a features file, located in JBoss Data Grid Maven repository under org/infinispan/infinispan-client-hotrod/${VERSION} ,
> which lists all dependencies required for correct functionality of the HotRod client in OSGi, while also making it simpler to install the whole 
> feature into Karaf (version 2.3.3 or 3.0).
>
>Also, it would be better to remove the example 4.3. The file now looks different and the versions are different as well. This would be hard to maintain in
>the future anyway.
>   
>* 5.1. Run JBoss Data Grid JAR Files (Remove Client-Server Mode)
>
>Please change the title --> "5.1. Run JBoss Data Grid (Remove Client-Server Mode)"  (i.e. exclude "JAR files")
>
>The paragraph shoudl be fixed:
>
>"Use the following instructions to run Red Hat JBoss Data Grid JAR files with Maven in Remote Client-Server mode. 
>Replace all instances of {VERSION} with the version provided with JBoss Data Grid. For example, for JBoss Data Grid 6.3,
>the {VERSION} value is replaced with 6.3.0." 
>--->
>"Use the following instructions to run Red Hat JBoss Data Grid with Maven in Remote Client-Server mode."
>
>* â 5.2. Run JBoss Data Grid JAR Files (Library Mode)
>
>Change the title ---> â "5.2. Run JBoss Data Grid (Library Mode)"
>
>Change the first paragraph --> "Use the provided instructions to run Red Hat JBoss Data Grid with Maven in Library mode."
>
>* 6.6. Running Red Hat JBoss Data Grid
>
>"Use the following command to run JBoss Data Grid with a clustered configuration:" 
>---->
>"Use the following command to run JBoss Data Grid with a default clustered configuration:"
>
>* 7.2. Sample Configuration for a Node without Endpoints
>
>Procedure 7.1, step 1) Change the sentence: 
>   "1. Extract the ZIP file for JBoss Data Grid Remote Client-Server mode. This is named jboss-datagrid-server-${version}-GA"
>   --->
>   "1. Extract the ZIP file for JBoss Data Grid Remote Client-Server mode. This is named jboss-datagrid-server-${version}"
>
>* Example 8.1. Adding a Profile
>
>Redundant "</settings>" at the end of the example.
>
>* â 10.2.4.2. Add the Default Cluster Configuration
>
>"Use GlobalConfiguration.clusteredDefault()"
>--->
>"Use new GlobalConfigurationBuilder().clusteredDefault()"
>
>* 10.2.4.3. Customize the Default Cluster Configuration
>
>"The jgroups.xml file is located at $Infinispan-Quickstart/clustered-cache/src/main/resources/" 
>---->
>"The jgroups.xml file is located at infinispan-quickstart/clustered-cache/src/main/resources/"
>
>* 11.1. Prerequisites
>
>The second and third bullet should look like this (the versions there are important):
>
>- Install and configure JBoss Operations Network 3.2.2 (or better)
>- Install and configure JBoss Data Grid (6.3 or better) Library mode plug-in.
>
>
>* â 13.3.2. Build and Deploy the CarMart Quickstart to JBoss EAP
>
>Could we remove the note there? Now I think it's more confusing than helpful.
>NOTE: The directions for this quickstart are for use with the selected version of JBoss EAP, not Red Hat JBoss Data Grid itself. JBoss Data Grid does not support application deployment as described in this quickstart.
>
>
>* 13.6.1. Build and Deploy the CarMart Quickstart in Remote Client-Server Mode
>
>Remove step 4. from the prerequisites. Starting the server is done alter as part of Procedure 13.10

Actions: View

Attachments on bug 1116809: 916038