forked from jbossas/archetypes
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bring archetype READMEs in synch with the quickstarts
- Loading branch information
Showing
6 changed files
with
364 additions
and
278 deletions.
There are no files selected for viewing
92 changes: 92 additions & 0 deletions
92
jboss-javaee6-webapp-archetype/src/main/resources/archetype-resources/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
${artifactId} | ||
======================== | ||
|
||
What is it? | ||
----------- | ||
|
||
This is your project! It is a sample, deployable Maven 3 project to help you get your foot in the door developing with Java EE 6 on JBoss Enterprise Application Platform 6 or JBoss AS 7. | ||
|
||
This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java. | ||
|
||
|
||
System requirements | ||
------------------- | ||
|
||
All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better. | ||
|
||
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 AS 7 with the Web Profile | ||
------------------------- | ||
|
||
1. Open a command line and navigate to the root of the JBoss server 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 | ||
|
||
|
||
Build and Deploy the Quickstart | ||
------------------------- | ||
|
||
_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._ | ||
|
||
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 this command to build and deploy the archive: | ||
|
||
mvn clean package jboss-as:deploy | ||
|
||
4. This will deploy `target/${artifactId}.war` to the running instance of the server. | ||
|
||
|
||
Access the application | ||
--------------------- | ||
|
||
The application will be running at the following URL: <http://localhost:8080/${artifactId}/>. | ||
|
||
|
||
Undeploy the Archive | ||
-------------------- | ||
|
||
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. When you are finished testing, type this command to undeploy the archive: | ||
|
||
mvn jboss-as:undeploy | ||
|
||
|
||
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._ | ||
|
||
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: | ||
|
||
mvn clean test -Parq-jbossas-remote | ||
|
||
|
||
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 | ||
|
86 changes: 0 additions & 86 deletions
86
jboss-javaee6-webapp-archetype/src/main/resources/archetype-resources/readme.md
This file was deleted.
Oops, something went wrong.
92 changes: 92 additions & 0 deletions
92
...javaee6-webapp-blank-archetype/src/main/resources/archetype-resources/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
${artifactId} | ||
======================== | ||
|
||
What is it? | ||
----------- | ||
|
||
This is your project! It is a sample, deployable Maven 3 project to help you get your foot in the door developing with Java EE 6 on JBoss Enterprise Application Platform 6 or JBoss AS 7. | ||
|
||
This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java. | ||
|
||
|
||
System requirements | ||
------------------- | ||
|
||
All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better. | ||
|
||
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 AS 7 with the Web Profile | ||
------------------------- | ||
|
||
1. Open a command line and navigate to the root of the JBoss server 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 | ||
|
||
|
||
Build and Deploy the Quickstart | ||
------------------------- | ||
|
||
_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._ | ||
|
||
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 this command to build and deploy the archive: | ||
|
||
mvn clean package jboss-as:deploy | ||
|
||
4. This will deploy `target/${artifactId}.war` to the running instance of the server. | ||
|
||
|
||
Access the application | ||
--------------------- | ||
|
||
The application will be running at the following URL: <http://localhost:8080/${artifactId}/>. | ||
|
||
|
||
Undeploy the Archive | ||
-------------------- | ||
|
||
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. When you are finished testing, type this command to undeploy the archive: | ||
|
||
mvn jboss-as:undeploy | ||
|
||
|
||
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._ | ||
|
||
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: | ||
|
||
mvn clean test -Parq-jbossas-remote | ||
|
||
|
||
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 | ||
|
86 changes: 0 additions & 86 deletions
86
...javaee6-webapp-blank-archetype/src/main/resources/archetype-resources/readme.md
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.