Permalink
Browse files

Attempt to standardize README.md files.

  • Loading branch information...
1 parent fc928e2 commit 8ddd885377872f8f20c05e042e644a6585398589 @sgilda sgilda committed Mar 26, 2012
Showing with 2,522 additions and 1,657 deletions.
  1. +48 −38 README.md
  2. +55 −18 bean-validation/README.md
  3. +51 −55 bmt/README.md
  4. +45 −22 cdi-injection/README.md
  5. +66 −71 cmt/README.md
  6. +24 −28 ejb-in-ear/README.md
  7. +47 −47 ejb-in-war/README.md
  8. +84 −60 ejb-remote/README.md
  9. +74 −30 ejb-security/README.md
  10. +74 −73 forge-from-scratch/README.md
  11. +61 −12 greeter/README.md
  12. +40 −49 h2-console/README.md
  13. +60 −39 helloworld-errai/README.md
  14. +57 −37 helloworld-gwt/README.md
  15. +29 −10 helloworld-jms/README.md
  16. +49 −37 helloworld-jsf/README.md
  17. +55 −23 helloworld-mdb/README.md
  18. +7 −7 helloworld-mdb/cheatsheets/helloworld-mdb.xml
  19. +61 −14 helloworld-osgi/README.md
  20. +76 −15 helloworld-rs/README.md
  21. +54 −24 helloworld-singleton/README.md
  22. +58 −11 helloworld/README.md
  23. +53 −34 hibernate3/README.md
  24. +59 −60 hibernate4/README.md
  25. +48 −23 jax-rs-client/README.md
  26. +78 −52 jts/README.md
  27. +45 −35 kitchensink-ear/README.md
  28. +59 −65 kitchensink-jsp/README.md
  29. +52 −53 kitchensink/README.md
  30. +47 −46 log4j/README.md
  31. +61 −13 mail/README.md
  32. +57 −9 numberguess/README.md
  33. +54 −30 payment-cdi-event/README.md
  34. +68 −53 richfaces-validation/README.md
  35. +4 −4 richfaces-validation/src/main/webapp/index.xhtml
  36. +53 −33 servlet-async/README.md
  37. +48 −29 servlet-filterlistener/README.md
  38. +71 −26 servlet-security/README.md
  39. +63 −31 shopping-cart/README.md
  40. +33 −43 tasks-jsf/README.md
  41. +33 −63 tasks/README.md
  42. +119 −19 template/README.md
  43. +40 −28 wicket-ear/README.md
  44. +61 −53 wsat-simple/README.md
  45. +52 −58 wsba-coordinator-completion-simple/README.md
  46. +44 −46 wsba-participant-completion-simple/README.md
  47. +45 −31 xml-jaxp/README.md
View
@@ -115,7 +115,7 @@ To run these quickstarts with the provided build scripts, you need the following
3. The JBoss Enterprise Application Platform 6 distribution ZIP or the JBoss AS 7 distribution ZIP.
* For information on how to install and run JBoss, refer to the product documentation.
-4. You can also deploy the quickstarts from Eclipse using JBoss tools. For more information on how to set up Maven and the JBoss tools, refer to the [Getting Started Developing Applications Guide](https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide "Getting Started Developing Applications Guide").
+4. You can also use [JBoss Developer Studio or Eclipse](#useeclipse) to run the quickstarts.
<a id="mavenconfiguration"></a>
@@ -170,7 +170,7 @@ The JBoss server can be started a few different ways.
The README for each quickstart will specify which configuration is required to run the example.
<a id="startserverweb"></a>
-#### Start the JBoss Enterprise Application Platform 6 or JBoss AS 7 Server with the Web Profile
+#### Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
1. Open a command line and navigate to the root of the JBoss directory.
2. The following shows the command line to start the server with the web profile:
@@ -179,7 +179,7 @@ The README for each quickstart will specify which configuration is required to r
For Windows: JBOSS_HOME\bin\standalone.bat
<a id="startserverfull"></a>
-#### Start the JBoss Enterprise Application Platform 6 or JBoss AS 7 Server with the Full Profile
+#### Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Full Profile
1. Open a command line and navigate to the root of the JBoss directory.
2. The following shows the command line to start the server with the full profile:
@@ -188,7 +188,7 @@ The README for each quickstart will specify which configuration is required to r
For Windows: JBOSS_HOME\bin\standalone.bat -c standalone-full.xml
<a id="startservercustom"></a>
-#### Start the JBoss Enterprise Application Platform 6 or JBoss AS 7 Server with the Custom Configuration Options
+#### Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with Custom Configuration Options
1. Open a command line and navigate to the root of the JBoss directory.
2. The following shows the command line to start the server. Replace the CUSTOM_OPTIONS with the custom optional parameters specified in the quickstart.
@@ -201,62 +201,70 @@ The README for each quickstart will specify which configuration is required to r
Review the README file in the root folder of the quickstart for specific details on how to build and run the example. In most cases you do the following:
-1. If required by the quickstart, make sure you [start the JBoss Server](#startjboss) as described in the README.
-2. Build and deploy the quickstarts
- 1. Open a command line and navigate to the root of the directory of the quickstart you want to run.
- 2. Build the archive
- * The command used to build the quickstart depends on the individual quickstart, the server version, and how you configured Maven.
- * If you are running JBoss AS 7, it uses community artifacts available in the Maven central repository, so command line arguments are not usually required.
- * If you are running JBoss Enterprise Application Platform 6 and did not configure the Maven user settings described in [Configure Maven for JBoss Enterprise Application Platform 6](#eap6mavenconfig) above, you need to specify command line arguments.
- * Although some of the quickstarts require special commands, for most of the quickstarts you do the one of the following.
-
- For JBoss Enterprise Application Platform 6, Maven user settings NOT configured:
+1. The command used to build the quickstart depends on the individual quickstart, the server version, and how you configured Maven.
+ * If you are running JBoss Enterprise Application Platform 6 and did not configure the Maven user settings described in [Configure Maven for JBoss Enterprise Application Platform 6](#eap6mavenconfig) above, you need to specify command line arguments.
+ * If you are running JBoss AS 7, it uses community artifacts available in the Maven central repository, so command line arguments are not usually required.
+2. See the README file in each individual quickstart folder for specific details and information on how to run and access the example.
+
+#### Build the Quickstart Archive
+
+In some cases, you may want to build the application to test for compile errors or view the contents of the archive.
+
+1. Open a command line and navigate to the root directory of the quickstart you want to build.
+2. Use this command if you only want to build the archive, but not deploy it:
+
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
mvn clean package -s PATH_TO_QUICKSTARTS/example-settings.xml
- For JBoss AS 7 or JBoss Enterprise Application Platform 6, Maven user settings configured:
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
mvn clean package
- 3. Deploy the archive built in the previous step by typing the following in the command line:
- mvn jboss-as:deploy
- 4. Alternatively, you can build and deploy the quickstart in one step. As in step 2. above when you built the archive, the command you use depends on the individual quickstart, the server version, and how you configured Maven. Although some of the quickstarts require special commands, for most of the quickstarts you do one of the following:
+#### Build and Deploy the Quickstart Archive
- For JBoss Enterprise Application Platform 6, Maven user settings NOT configured:
+1. Make sure you [start the JBoss Server](#startjboss) as described in the README.
+2. Open a command line and navigate to the root directory of the quickstart you want to run.
+3. Use this command to build and deploy the archive:
- mvn package jboss-as:deploy -s PATH_TO_QUICKSTARTS/example-settings.xml
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
- For JBoss AS 7 or JBoss Enterprise Application Platform 6, Maven user settings configured:
+ mvn clean package jboss-as:deploy -s PATH_TO_QUICKSTARTS/example-settings.xml
- mvn package jboss-as:deploy
- 5. The command to undeploy the quickstart is simply:
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
- mvn jboss-as:undeploy
- 6. If you want to redeploy a quickstart that uses a database, you should undeploy it first. This ensures the database is cleaned up correctly before the redeploy.
+ mvn clean package jboss-as:deploy
+
+#### Undeploy an Archive
-3. See the README file in each individual quickstart folder for specific details and information on how to run and access the example.
+The command to undeploy the quickstart is simply:
-4. You can also start the JBoss Application Server and deploy the quickstarts using Eclipse. See the [Getting Started Developing Applications Guide](https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide "Getting Started Developing Applications Guide") for more information.
+ mvn jboss-as:undeploy
+
<a id="arquilliantests"></a>
### Run the Arquillian Tests
-------------------------
Some of the quickstarts provide Arquillian tests. By default, these tests are configured to be skipped, as Arquillian tests require the use of a container.
-You can run these tests using either a managed or remote container.
+You can run these tests using either a remote or managed container.
+
+<a id="testremote"/>
1. Test the quickstart on a Remote Server
* A remote container requires you start the JBoss Enterprise Application Platform 6 or JBoss AS 7 server before running the test. [Start the JBoss Server](#startjboss) as described in the quickstart README file.
* Run the test goal with the following profile activated:
- For JBoss Enterprise Application Platform 6, Maven user settings NOT configured:
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
mvn clean test -Parq-jbossas-remote -s PATH_TO_QUICKSTARTS/example-settings.xml
- For JBoss AS 7 or JBoss Enterprise Application Platform 6, Maven user settings configured:
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
mvn clean test -Parq-jbossas-remote
+<a id="testmanaged"/>
+
2. Test the quickstart on Managed Server
* This test requires that your server is not running. Arquillian will start the container for you, however, you must first let it know where to find the remote JBoss container.
* Open the test/resources/arquillian.xml file located in the quickstart directory.
@@ -273,16 +281,20 @@ You can run these tests using either a managed or remote container.
* Run the test goal with the following profile activated:
- For JBoss Enterprise Application Platform 6, Maven user settings NOT configured:
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
mvn clean test -Parq-jbossas-managed -s PATH_TO_QUICKSTARTS/example-settings.xml
- For JBoss AS 7 or JBoss Enterprise Application Platform 6, Maven user settings configured:
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
mvn clean test -Parq-jbossas-managed
The quickstart README should tell you what you should expect to see in the console output and server log when you run the test.
+<a id="useeclipse"/>
+Use JBoss Developer Studio or Eclipse to Run the Quickstarts
+-------------------------------------
+You can also deploy the quickstarts from Eclipse using JBoss tools. For more information on how to set up Maven and the JBoss tools, refer to the [Boss Enterprise Application Platform 6 Beta](http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/6/html/Beta_Documentation/HOME.html) documentation or the [Getting Started Developing Applications Guide](https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide "Getting Started Developing Applications Guide").
<a id="optionalcomponents"></a>
@@ -326,7 +338,7 @@ The following procedures describe how to add a user with the appropriate permiss
Enter the details of the new user to add.
Realm (ManagementRealm) :
- At the prompt, press enter to take the default ManagementRealm
+ If the quickstart README specifies a realm, type it here. Otherwise, press enter to take the default `ManagementRealm`.
5. When prompted, enter the following
Username : admin
@@ -357,14 +369,12 @@ The following procedures describe how to add a user with the appropriate permiss
Enter the details of the new user to add.
Realm (ApplicationRealm) :
- At the prompt, press enter to take the default ApplicationRealm
-5. When prompted, enter the following
+ If the quickstart README specifies a realm, type it here. Otherwise, press enter to take the default `ApplicationRealm`.
+5. When prompted, enter the the Username and Passord. If the quickstart README specifies a Username nad Password, enter them here. Otherwise, use the default Username `quickstartUser` and Password `quickstartPassword`.
Username : quickstartUser
Password : quickstartPassword
-6. When asked "What roles do you want this user to belong to?", enter:
-
- guest
+6. At the next prompt, you will be asked "What roles do you want this user to belong to?". If the quickstart README specifies a role to use, enter that here. Otherwise, type the role: `guest`
<a id="postgresql"></a>
@@ -5,37 +5,59 @@ Author: Karel Piwko <kpiwko@redhat.com>
What is it?
-----------
-This is your project! It's a sample, Maven 3 project to help you
-get your foot in the door developing with Java EE 6 on JBoss AS 7 or JBoss Enterprise Application Platform 6.
-This project is setup to allow you to use CDI 1.0, JPA 2.0 and Bean Validation 1.0.
-It includes a persistence unit and some sample persistence code to help
-you get your feet wet with database access in enterprise Java.
+This project demonstrates how to use CDI 1.0, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence code to introduce you to database access in enterprise Java.
+
+This quickstart does not contain a user interface layer. The purpose of this project is to show you how to test bean validation with Arquillian. If you want to see an example of how to test bean validation with a user interface, look at the [kitchensink](../kitchensink/README.html) example.
-It does not contain an user interface layer. The main purpose of the project is
-to show you how to test Bean Validation with Arquillian. If you want to see an
-example how to test Bean Validation via an user interface, check out Kitchensink
-example available at <https://github.com/jbossas/quickstart/tree/master/kitchensink>.
System requirements
-------------------
-All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven
-3.0 or better.
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
-Running the Arquillian tests
-----------------------------
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
+
+
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
+-------------------------
+
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
+
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
+
+
+Run the Arquillian Tests
+-------------------------
+
+This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.
+
+_NOTE: The following commands assume you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Run the Arquillian Tests](../README.html/#arquilliantests) for complete instructions and additional options._
-This quickstart provides Arquillian tests. See [Run the Arquillian Tests](../README.html/#arquilliantests) for more information on how to set up and run the tests. When asked to start the JBoss Server, this quickstart requires that you start it with the _web_ profile.
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type the following command to run the test goal with the following profile activated:
-### Investigate the Console Output
+ mvn clean test -Parq-jbossas-remote
+
+
+Investigate the Console Output
+----------------------------
When you run the tests, JUnit will present you test report summary:
Tests run: 5, Failures: 0, Errors: 0, Skipped: 0
-If you are interested in more details, check ``target/surefire-reports`` directory.
-You can check console output to verify that Arquillian had really used the real application server.
-Search for lines similar to the following ones in the server output log:
+If you are interested in more details, look in the `target/surefire-reports` directory.
+
+You can also check the server console output to verify that the Arquillian tests deployed to and ran in the application server. Search for lines similar to the following ones in the server output log:
[timestamp] INFO [org.jboss.as.server.deployment] (MSC service thread 1-2) Starting deployment of "test.war"
...
@@ -45,5 +67,20 @@ Search for lines similar to the following ones in the server output log:
...
[timestamp] INFO [org.jboss.as.server] (management-handler-threads - 1) JBAS018558: Undeployed "test.war
+
+
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
+
+
+Debug the Application
+------------------------------------
+
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
+
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
+
Oops, something went wrong.

0 comments on commit 8ddd885

Please sign in to comment.