Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edits to README files to render metadata correctly and to use the correct term for JBoss EAP #119

Merged
merged 1 commit into from Feb 28, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 21 additions & 21 deletions README.md
Expand Up @@ -139,48 +139,48 @@ Run the Quickstarts

The root folder of each individual quickstart contains a README file with specific details on how to build and run the example. In most cases you do the following:

* [Start the JBoss server](#start-the-jboss-server)
* [Start the JBoss EAP server](#start-the-jboss-eap-server)
* [Build and deploy the quickstarts](#build-and-deploy-the-quickstarts)


### Start the JBoss Server
### Start the JBoss EAP Server

Before you deploy a quickstart, in most cases you need a running JBoss EAP server. A few of the Arquillian tests do not require a running server. This will be noted in the README for that quickstart.

The JBoss server can be started a few different ways.
The JBoss EAP server can be started a few different ways.

* [Start the Default JBoss Server](#start-the-default-jboss-server): This is the default configuration. It defines minimal subsystems and services.
* [Start the JBoss Server with the _full_ profile](#start-the-jboss-server-with-the-full-profile): This profile configures many of the commonly used subsystems and services.
* [Start the JBoss Server with a custom configuration](#start-the-jboss-server-with-custom-configuration-options): Custom configuration parameters can be specified on the command line when starting the server.
* [Start the Default JBoss EAP Server](#start-the-default-jboss-eap-server): This is the default configuration. It defines minimal subsystems and services.
* [Start the JBoss EAP Server with the _full_ profile](#start-the-jboss-eap-server-with-the-full-profile): This profile configures many of the commonly used subsystems and services.
* [Start the JBoss EAP Server with a custom configuration](#start-the-jboss-eap-server-with-custom-configuration-options): Custom configuration parameters can be specified on the command line when starting the server.

The README for each quickstart will specify which configuration is required to run the example.

#### Start the Default JBoss Server
#### Start the Default JBoss EAP Server

To start JBoss EAP:

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 JBoss server:
1. Open a command line and navigate to the root of the JBoss EAP directory.
2. The following shows the command line to start the JBoss EAP server:

For Linux: JBOSS_HOME/bin/standalone.sh
For Windows: JBOSS_HOME\bin\standalone.bat

#### Start the JBoss Server with the Full Profile
#### Start the JBoss EAP Server with the Full Profile

To start JBoss EAP with the Full 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 JBoss server with the full profile:
1. Open a command line and navigate to the root of the JBoss EAP directory.
2. The following shows the command line to start the JBoss EAP server with the full profile:

For Linux: JBOSS_HOME/bin/standalone.sh -c standalone-full.xml
For Windows: JBOSS_HOME\bin\standalone.bat -c standalone-full.xml

#### Start the JBoss Server with Custom Configuration Options
#### Start the JBoss EAP Server with Custom Configuration Options

To start JBoss EAP with custom configuration options:

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 JBoss server. Replace the CUSTOM_OPTIONS with the custom optional parameters specified in the quickstart.
1. Open a command line and navigate to the root of the JBoss EAP directory.
2. The following shows the command line to start the JBoss EAP server. Replace the CUSTOM_OPTIONS with the custom optional parameters specified in the quickstart.

For Linux: JBOSS_HOME/bin/standalone.sh CUSTOM_OPTIONS
For Windows: JBOSS_HOME\bin\standalone.bat CUSTOM_OPTIONS
Expand All @@ -200,7 +200,7 @@ In some cases, you may want to build the application to test for compile errors

#### Build and Deploy the Quickstart Archive

1. Make sure you [start the JBoss server](#start-the-jboss-server) as described in the README.
1. Make sure you [start the JBoss EAP server](#start-the-jboss-eap-server) 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:

Expand All @@ -219,7 +219,7 @@ You can verify the quickstarts build using one command. However, quickstarts tha

To build the quickstarts:

1. Do not start the JBoss server.
1. Do not start the JBoss EAP server.
2. Open a command line and navigate to the root directory of the quickstarts.
3. Use this command to build the quickstarts that do not have complex dependencies:

Expand All @@ -238,7 +238,7 @@ To undeploy the quickstarts from the root of the quickstart folder, you must pas

You can undeploy quickstarts using the following procedure:

1. Start the JBoss server.
1. Start the JBoss EAP server.
2. Open a command line and navigate to the root directory of the quickstarts.
3. Use this command to undeploy any deployed quickstarts:

Expand All @@ -256,8 +256,8 @@ You can either start the server yourself or let Arquillian manage its lifecycle


1. Test the quickstart on a remote server
* Arquillian's remote container adapter expects a JBoss server instance to be already started prior to the test execution. You must [Start the JBoss server](#start-the-jboss-server) as described in the quickstart README file.
* If you need to run the tests on a JBoss server running on a machine other than localhost, you can configure this, along with other options, in the `src/test/resources/arquillian.xml` file using the following properties:
* Arquillian's remote container adapter expects a JBoss EAP server instance to be already started prior to the test execution. You must [Start the JBoss EAP server](#start-the-jboss-eap-server) as described in the quickstart README file.
* If you need to run the tests on a JBoss EAP server running on a machine other than localhost, you can configure this, along with other options, in the `src/test/resources/arquillian.xml` file using the following properties:

<container qualifier="jboss" default="true">
<configuration>
Expand All @@ -272,7 +272,7 @@ You can either start the server yourself or let Arquillian manage its lifecycle
mvn clean test -Parq-jbossas-remote
2. Test the quickstart on a managed server

Arquillian's managed container adapter requires that your server is not running as it will start the container for you. However, you must first let it know where to find the JBoss server directory. The simplest way to do this is to set the `JBOSS_HOME` environment variable to the full path to your JBoss server directory. Alternatively, you can set the path in the `jbossHome` property in the Arquillian configuration file.
Arquillian's managed container adapter requires that your server is not running as it will start the container for you. However, you must first let it know where to find the JBoss EAP directory. The simplest way to do this is to set the `JBOSS_HOME` environment variable to the full path to your JBoss EAP directory. Alternatively, you can set the path in the `jbossHome` property in the Arquillian configuration file.
* Open the `src/test/resources/arquillian.xml` file located in the quickstart directory.
* Find the configuration for the JBoss container. It should look like this:

Expand Down
22 changes: 11 additions & 11 deletions cdi-add-interceptor-binding/README.md
@@ -1,12 +1,12 @@
cdi-add-interceptor-binding: An example of a Portable Extension and some of the APIs / SPIs of CDI
======================================================
Author: Pete Muir
Level: Intermediate
Technologies: CDI, DeltaSpike
Summary: Creating a basic CDI extension to automatically add an interceptor binding
Target Product: WFK
Product Versions: EAP 6.1, EAP 6.2, WFK 2.5
Source: <https://github.com/jboss-developer/jboss-wfk-quickstarts/>
Author: Pete Muir
Level: Intermediate
Technologies: CDI, DeltaSpike
Summary: Creating a basic CDI extension to automatically add an interceptor binding
Target Product: WFK
Product Versions: EAP 6.1, EAP 6.2, WFK 2.5
Source: <https://github.com/jboss-developer/jboss-wfk-quickstarts/>

What is it?
-----------
Expand Down Expand Up @@ -40,11 +40,11 @@ Configure Maven

If you have not yet done so, you must [Configure Maven](../README.md#configure-maven) before testing the quickstarts.

Start the JBoss Server
Start the JBoss EAP Server
-------------------------

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:
1. Open a command line and navigate to the root of the JBoss EAP directory.
2. The following shows the command line to start the server with the default profile:

For Linux: JBOSS_HOME/bin/standalone.sh
For Windows: JBOSS_HOME\bin\standalone.bat
Expand All @@ -57,7 +57,7 @@ This quickstart provides Arquillian tests. By default, these tests are configure

_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.md#run-the-arquillian-tests) for complete instructions and additional options._

1. Make sure you have started the JBoss Server as described above.
1. Make sure you have started the JBoss EAP 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:

Expand Down
14 changes: 7 additions & 7 deletions contacts-mobile-basic/README.md
Expand Up @@ -65,10 +65,10 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.md#configure-maven) before testing the quickstarts.


Start the JBoss Server
Start the JBoss EAP Server
-----------------------

1. Open a command line and navigate to the root of the JBoss server directory.
1. Open a command line and navigate to the root of the JBoss EAP directory.
2. The following shows the command line to start the server with the default profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand All @@ -85,7 +85,7 @@ Start the JBoss Server
Build and Deploy the Quickstart
-------------------------------

1. Make sure you have started the JBoss Server as described above.
1. Make sure you have started the JBoss EAP 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:

Expand Down Expand Up @@ -145,7 +145,7 @@ FAQ
Undeploy the Archive
--------------------

1. Make sure you have started the JBoss Server as described above.
1. Make sure you have started the JBoss EAP 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:

Expand All @@ -165,13 +165,13 @@ To run these tests, you must build the main project as described above.
mvn clean package

3. Navigate to the functional-tests/ directory in this quickstart.
4. If you have a running instance of the JBoss Server, as described above, run the remote tests by typing the following command:
4. If you have a running instance of the JBoss EAP server, as described above, run the remote tests by typing the following command:

mvn clean verify -Parq-jbossas-remote

5. If you prefer to run the functional tests using managed instance of the JBoss server, meaning the tests will start the server for you, type the following command:
5. If you prefer to run the functional tests using managed instance of the JBoss EAP server, meaning the tests will start the server for you, type the following command:

_NOTE: For this to work, Arquillian needs to know the location of the JBoss server. This can be declared through the `JBOSS_HOME` environment variable or the `jbossHome` property in `arquillian.xml`. See [Run the Arquillian Tests](../README.md#run-the-arquillian-tests) for complete instructions and additional options._
_NOTE: For this to work, Arquillian needs to know the location of the JBoss EAP server. This can be declared through the `JBOSS_HOME` environment variable or the `jbossHome` property in `arquillian.xml`. See [Run the Arquillian Tests](../README.md#run-the-arquillian-tests) for complete instructions and additional options._

mvn clean verify -Parq-jbossas-managed

Expand Down
30 changes: 15 additions & 15 deletions deltaspike-authorization/README.md
@@ -1,13 +1,13 @@
deltaspike-authorization: Demonstrate the creation of a custom authorization example using @SecurityBindingType from DeltaSpike
======================================================
Author: Rafael Benevides
Level: Beginner
Technologies: JSF, CDI, Deltaspike
Summary: Demonstrate the creation of a custom authorization example using @SecurityBindingType from DeltaSpike
Prerequisites:
Target Product: WFK
Product Versions: EAP 6.1, EAP 6.2, WFK 2.5
Source: <https://github.com/jboss-developer/jboss-wfk-quickstarts/>
Author: Rafael Benevides
Level: Beginner
Technologies: JSF, CDI, Deltaspike
Summary: Demonstrate the creation of a custom authorization example using @SecurityBindingType from DeltaSpike
Prerequisites:
Target Product: WFK
Product Versions: EAP 6.1, EAP 6.2, WFK 2.5
Source: <https://github.com/jboss-developer/jboss-wfk-quickstarts/>

What is it?
-----------
Expand Down Expand Up @@ -42,10 +42,10 @@ Add an Application User
This quickstart uses secured management interfaces and requires that you create an application user to access the running application. Instructions to set up the quickstart application user can be found here: [Add an Application User](../README.md#add-an-application-user)


Start the JBoss Server
Start the JBoss EAP Server
-------------------------

1. Open a command line and navigate to the root of the JBoss server directory.
1. Open a command line and navigate to the root of the JBoss EAP directory.
2. The following shows the command line to start the server with the default profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand All @@ -56,7 +56,7 @@ 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.md#build-and-deploy-the-quickstarts) for complete instructions and additional options._

1. Make sure you have started the JBoss Server as described above.
1. Make sure you have started the JBoss EAP 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:

Expand All @@ -78,7 +78,7 @@ When you click on the `Admin Method` button you will be redirected to a error pa
Undeploy the Archive
--------------------

1. Make sure you have started the JBoss Server as described above.
1. Make sure you have started the JBoss EAP 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:

Expand All @@ -97,13 +97,13 @@ To run these tests, you must build the main project as described above.
mvn clean package

3. Navigate to the functional-tests/ directory in this quickstart.
4. If you have a running instance of the JBoss Server, as described above, run the remote tests by typing the following command:
4. If you have a running instance of the JBoss EAP server, as described above, run the remote tests by typing the following command:

mvn clean verify -Parq-jbossas-remote

5. If you prefer to run the functional tests using managed instance of the JBoss server, meaning the tests will start the server for you, type the following command:
5. If you prefer to run the functional tests using managed instance of the JBoss EAP server, meaning the tests will start the server for you, type the following command:

_NOTE: For this to work, Arquillian needs to know the location of the JBoss server. This can be declared through the `JBOSS_HOME` environment variable or the `jbossHome` property in `arquillian.xml`. See [Run the Arquillian Tests](../README.md#run-the-arquillian-tests) for complete instructions and additional options._
_NOTE: For this to work, Arquillian needs to know the location of the JBoss EAP server. This can be declared through the `JBOSS_HOME` environment variable or the `jbossHome` property in `arquillian.xml`. See [Run the Arquillian Tests](../README.md#run-the-arquillian-tests) for complete instructions and additional options._

mvn clean verify -Parq-jbossas-managed

Expand Down
22 changes: 11 additions & 11 deletions deltaspike-beanbuilder/README.md
@@ -1,12 +1,12 @@
deltaspike-beanbuilder: Shows how to create new beans using DeltaSpike utilities
======================================================
Author: Rafael Benevides
Level: Advanced
Technologies: CDI, DeltaSpike
Summary: Shows how to create new beans using DeltaSpike utilities.
Target Product: WFK
Product Versions: EAP 6.1, EAP 6.2, WFK 2.5
Source: <https://github.com/jboss-developer/jboss-wfk-quickstarts/>
Author: Rafael Benevides
Level: Advanced
Technologies: CDI, DeltaSpike
Summary: Shows how to create new beans using DeltaSpike utilities.
Target Product: WFK
Product Versions: EAP 6.1, EAP 6.2, WFK 2.5
Source: <https://github.com/jboss-developer/jboss-wfk-quickstarts/>

What is it?
-----------
Expand All @@ -32,11 +32,11 @@ Configure Maven

If you have not yet done so, you must [Configure Maven](../README.md#configure-maven) before testing the quickstarts.

Start the JBoss Server
Start the JBoss EAP Server
-------------------------

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:
1. Open a command line and navigate to the root of the JBoss EAP directory.
2. The following shows the command line to start the server with the default profile:

For Linux: JBOSS_HOME/bin/standalone.sh
For Windows: JBOSS_HOME\bin\standalone.bat
Expand All @@ -49,7 +49,7 @@ This quickstart provides Arquillian tests. By default, these tests are configure

_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.md#run-the-arquillian-tests) for complete instructions and additional options._

1. Make sure you have started the JBoss Server as described above.
1. Make sure you have started the JBoss EAP 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:

Expand Down