diff --git a/helloworld-mdb/README.md b/helloworld-mdb/README.md index 8c22071b29..e45730b3a7 100644 --- a/helloworld-mdb/README.md +++ b/helloworld-mdb/README.md @@ -99,8 +99,6 @@ for more information. Build and Deploy the Quickstart - to OpenShift ------------------------- -_NOTE: At the time of this writing, JBoss Enterprise Application Platform 6 is not yet available on OpenShift, so only the JBoss AS 7 version of this quickstart can be deployed to OpenShift_. - ### Create an OpenShift Account and Domain If you do not yet have an OpenShift account and domain, [Sign in to OpenShift](https://openshift.redhat.com/app/login) to create the account and domain. [Get Started with OpenShift](https://openshift.redhat.com/app/getting_started) will show you how to install the OpenShift Express command line interface. diff --git a/helloworld-rs/README.md b/helloworld-rs/README.md index ee8ed82487..617513d131 100644 --- a/helloworld-rs/README.md +++ b/helloworld-rs/README.md @@ -86,8 +86,6 @@ If you want to debug the source code or look at the Javadocs of any library in t Build and Deploy the Quickstart - to OpenShift ------------------------- -_NOTE: At the time of this writing, JBoss Enterprise Application Platform 6 is not yet available on OpenShift, so only the JBoss AS 7 version of this quickstart can be deployed to OpenShift_. - ### Create an OpenShift Express Account and Domain If you do not yet have an OpenShift account and domain, [Sign in to OpenShift](https://openshift.redhat.com/app/login) to create the account and domain. [Get Started with OpenShift](https://openshift.redhat.com/app/getting_started) will show you how to install the OpenShift Express command line interface. diff --git a/jax-rs-client/README.md b/jax-rs-client/README.md index 1a84f8a1ca..44e03ebe56 100644 --- a/jax-rs-client/README.md +++ b/jax-rs-client/README.md @@ -90,8 +90,6 @@ To make this quickstart more interesting, deploy the RESTful service to OpenShif Build and Deploy the Quickstart - to OpenShift ------------------------- -_NOTE: At the time of this writing, JBoss Enterprise Application Platform 6 is not yet available on OpenShift, so only the JBoss AS 7 version of this quickstart can be deployed to OpenShift_. - ### Create an OpenShift Express Account and Domain If you do not yet have an OpenShift account and domain, [Sign in to OpenShift](https://openshift.redhat.com/app/login) to create the account and domain. [Get Started with OpenShift](https://openshift.redhat.com/app/getting_started) will show you how to install the OpenShift Express command line interface. diff --git a/template/README.md b/template/README.md index 9d02c394be..8f41c3c8ea 100644 --- a/template/README.md +++ b/template/README.md @@ -4,10 +4,12 @@ Author: YOUR_NAME and optional CONTACT_INFO _This file is meant to serve as a template or guideline for your own quickstart README.md file. Be sure to replace QUICKSTART_NAME and YOUR_NAME, with the appropriate values._ +Contributor instructions are prefixed with 'Contributor: ' + What is it? ----------- -This is where you provide an overview of what the quickstart demonstrates. For example: +Contributor: This is where you provide an overview of what the quickstart demonstrates. For example: * What are the technologies demonstrated by the quickstart? * What does it do when you run it? @@ -20,6 +22,8 @@ If possible, give an overview, including any code they should look at to underst System requirements ------------------- +Contributor: For example: + 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. @@ -28,7 +32,7 @@ The application this project produces is designed to be run on JBoss Enterprise Configure Maven --------------- -You can copy or link to the Maven configuration information in the README file in the root folder of the quickstarts. For example: +Contributor: You can copy or link to the Maven configuration information in the README file in the root folder of the quickstarts. For example: If you have not yet done so, you must [Configure Maven](../README.md#mavenconfiguration) before testing the quickstarts. @@ -36,11 +40,7 @@ If you have not yet done so, you must [Configure Maven](../README.md#mavenconfig Configure Optional Components ------------------------- -If your quickstart requires any additional components, decribe how to set them up here. - -If your quickstart requires a secured user, PostgreSQL, or Byteman, you can link to the instructions in the README file located in the root folder of the quickstart directory. - -Here are some examples: +Contributor: If your quickstart requires any additional components, decribe how to set them up here. If your quickstart requires a secured user, PostgreSQL, or Byteman, you can link to the instructions in the README file located in the root folder of the quickstart directory. Here are some examples: * This quickstart uses a secured management interface and requires that you create a management (or application) user to access the running application. Instructions to set up a Management (or Application) user can be found here: @@ -52,13 +52,11 @@ Here are some examples: * This quickstart uses Byteman to help demonstrate crash recovery. Instructions to install and configure Byteman can be found here: [Install and Configure Byteman](../README.md#byteman) -If your quickstart requires any other components, you must describe how to configure them here. - Start JBoss Enterprise Application Platform 6 or JBoss AS 7 ------------------------- -Does this quickstart require a running server? If so, you must show how to start the server. If you start the server in one of the following 3 ways, you can simply copy the instructions in the README file located in the root folder of the quickstart directory: +Contributor: Does this quickstart require one or more running servers? If so, you must show how to start the server. If you start the server in one of the following 3 ways, you can simply copy the instructions in the README file located in the root folder of the quickstart directory: * Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile @@ -68,13 +66,13 @@ Does this quickstart require a running server? If so, you must show how to start `--server-config=../../docs/examples/configs/standalone-xts.xml` -If the server is started in a different manner than above, give the specific instructions. +Contributor: If the server is started in a different manner than above, give the specific instructions. Build and Deploy the Quickstart ------------------------- -If the quickstart is built and deployed using the standard Maven commands, "mvn clean package" and "mvn jboss-as:deploy", copy the following: +Contributor: If the quickstart is built and deployed using the standard Maven commands, "mvn clean package" and "mvn jboss-as:deploy", copy the following: _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#buildanddeploy) for complete instructions and additional options._ @@ -85,18 +83,18 @@ _NOTE: The following build command assumes you have configured your Maven user s mvn clean package jboss-as:deploy 4. This will deploy `target/jboss-as-QUICKSTART_NAME.war` (or `target/jboss-as-QUICKSTART_NAME.ear`) to the running instance of the server. -Be sure to replace the QUICKSTART_NAME. If this quickstart requires different or additional instructions, be sure to modify or add those instructions here. +Contributor: Be sure to replace the QUICKSTART_NAME. If this quickstart requires different or additional instructions, be sure to modify or add those instructions here. Access the application (For quickstarts that have a UI component) --------------------- -Provide the URL to access the running application. Be sure to make the URL a hyperlink as below, substituting the your quickstart name for the QUICKSTART_NAME. +Contributor: Provide the URL to access the running application. Be sure to make the URL a hyperlink as below, substituting the your quickstart name for the QUICKSTART_NAME. Access the running application in a browser at the following URL: -Briefly describe what you will see when you access the application. For example: +Contributor: Briefly describe what you will see when you access the application. For example: You will be presented with a simple form for adding key/value pairs and a checkbox to indicate whether the updates should be executed using an unmanaged component. @@ -107,12 +105,14 @@ Briefly describe what you will see when you access the application. For example: To add or update the value of a key, enter a key and value input boxe and click the submit button to see the results. -Add any information that will help them run and understand your quickstart. +Contributor: Add any information that will help them run and understand your quickstart. Undeploy the Archive -------------------- +Contributor: For example: + 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: @@ -123,6 +123,8 @@ Undeploy the Archive Run the Arquillian Tests (For quickstarts that contain Arquillian tests) ------------------------- +Contributor: For example: + 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.md#arquilliantests) for complete instructions and additional options._ @@ -133,7 +135,7 @@ _NOTE: The following commands assume you have configured your Maven user setting mvn clean test -Parq-jbossas-remote -The quickstart README should show what to expect from the the tests +Contributor: The quickstart README should show what to expect from the the tests * Copy and paste output from the JUnit tests to show what to expect in the console from the tests. @@ -143,29 +145,29 @@ The quickstart README should show what to expect from the the tests Run the Quickstart in JBoss Developer Studio or Eclipse ------------------------------------- +Contributor: For example: + 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.md#useeclipse) Debug the Application ------------------------------------ +Contributor: For example: + 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 ------------------------------------- - -If the quickstart deploys to OpenShift, you can use the following template a starting point to describe the process. -Note: - -* QUICKSTART_NAME should be replaced with your quicktart name, for example: my-quickstart -* OPENSHIFT_QUICKSTART_NAME should be replaced with a variation of the quickstart name, for example: myquickstart Build and Deploy the Quickstart - to OpenShift ------------------------- -_NOTE: At the time of this writing, JBoss Enterprise Application Platform 6 is not yet available on OpenShift, so only the JBoss AS 7 version of this quickstart can be deployed to OpenShift_. +Contributor: If the quickstart deploys to OpenShift, you can use the following template a starting point to describe the process. Be sure to note: + +* QUICKSTART_NAME should be replaced with your quicktart name, for example: my-quickstart +* OPENSHIFT_QUICKSTART_NAME should be replaced with a variation of the quickstart name, for example: myquickstart ### Create an OpenShift Account and Domain diff --git a/wsat-simple/README.md b/wsat-simple/README.md index 6713405adb..557c4494c1 100644 --- a/wsat-simple/README.md +++ b/wsat-simple/README.md @@ -137,8 +137,6 @@ If you want to debug the source code or look at the Javadocs of any library in t Build and Deploy the Quickstart - to OpenShift ------------------------- -_NOTE: At the time of this writing, JBoss Enterprise Application Platform 6 is not yet available on OpenShift, so only the JBoss AS 7 version of this quickstart can be deployed to OpenShift_. - ### Create an OpenShift Express Account and Domain If you do not yet have an OpenShift account and domain, [Sign in to OpenShift](https://openshift.redhat.com/app/login) to create the account and domain. [Get Started with OpenShift](https://openshift.redhat.com/app/getting_started) will show you how to install the OpenShift Express command line interface.