-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[resolves #838] Remove markdown from archetype generated README files
- Loading branch information
1 parent
432d0fc
commit feb09ae
Showing
5 changed files
with
112 additions
and
68 deletions.
There are no files selected for viewing
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
87 changes: 54 additions & 33 deletions
87
archetypes/archetype-cdi/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 |
|---|---|---|
| @@ -1,77 +1,98 @@ | ||
| #set( $symbol_hash = '#' ) | ||
| ${symbol_hash} ${artifactId} | ||
| WildFly Camel CDI Web Application | ||
| ============= | ||
|
|
||
| This is a template Apache Camel CDI application for the WildFly-Camel subsystem. | ||
| This is a template Apache Camel CDI application for the WildFly Camel subsystem. | ||
|
|
||
| This project is setup to allow you to create a Apache Camel CDI application, which can be deployed to an application | ||
| server running the WildFly-Camel subsystem. An example CDI Camel Route has been created for you, together with an Arquillian | ||
| server running the WildFly Camel subsystem. An example CDI Camel Route has been created for you, together with an Arquillian | ||
| integration test. | ||
|
|
||
| ${symbol_hash}${symbol_hash} Prerequisites | ||
| Prerequisites | ||
| ============= | ||
|
|
||
| * Minimum of Java 1.7 | ||
| * Maven 3.2 or greater | ||
| * WildFly application server version ${version-wildfly} | ||
| * WildFly application server. Refer to the WildFly Camel compatibility matrix for more information. | ||
|
|
||
| ${symbol_hash}${symbol_hash} Getting started | ||
| http://wildflyext.gitbooks.io/wildfly-camel/content/start/compatibility.html | ||
|
|
||
| 1. Install WildFly-Camel subsystem distribution version ${version} on your application server | ||
|
|
||
| 2. Conifgure a `$JBOSS_HOME` environment variable to point at your application server installation directory | ||
| Getting started | ||
| --------------- | ||
|
|
||
| 1. Install the WildFly Camel subsystem distribution on your application server | ||
|
|
||
| 2. Configure a $JBOSS_HOME environment variable to point at your application server installation directory | ||
|
|
||
| 3. Start the application server from the command line | ||
|
|
||
| For Linux: | ||
|
|
||
| `$JBOSS_HOME/bin/standalone.sh -c standalone-camel.xml` | ||
| $JBOSS_HOME/bin/standalone.sh -c standalone-camel.xml | ||
|
|
||
| For Windows: | ||
|
|
||
| `%JBOSS_HOME%\bin\standalone.bat -c standalone-camel.xml` | ||
| %JBOSS_HOME%\bin\standalone.bat -c standalone-camel.xml | ||
|
|
||
|
|
||
| ${symbol_hash}${symbol_hash}${symbol_hash} Building the application | ||
| Building the application | ||
| ------------------------ | ||
|
|
||
| To build the application do: | ||
|
|
||
| `mvn clean install` | ||
| mvn clean install | ||
|
|
||
| ${symbol_hash}${symbol_hash}${symbol_hash} Run Arquillian Tests | ||
|
|
||
| Run Arquillian Tests | ||
| -------------------- | ||
|
|
||
| By default, tests are configured to be skipped as Arquillian requires the use of a container. | ||
|
|
||
| If you already have a running application server, you can run integration tests with: | ||
|
|
||
| `mvn clean test -Parq-remote` | ||
| mvn clean test -Parq-remote | ||
|
|
||
| Otherwise you can get Arquillian to start and stop the server for you (Note: you must have $JBOSS_HOME configured beforehand): | ||
|
|
||
| Otherwise you can get Arquillian to start and stop the server for you (Note: you must have `JBOSS_HOME` configured beforehand): | ||
| mvn clean test -Parq-managed | ||
|
|
||
| `mvn clean test -Parq-managed` | ||
|
|
||
| ${symbol_hash}${symbol_hash}${symbol_hash} Deploying the application | ||
| Deploying the application | ||
| ------------------------- | ||
|
|
||
| To deploy the application to a running application server do: | ||
|
|
||
| `mvn clean package wildfly:deploy` | ||
| mvn clean package wildfly:deploy | ||
|
|
||
| The server console should display lines like the following: | ||
|
|
||
| ``` | ||
| (MSC service thread 1-16) Apache Camel (CamelContext: cdi-context) is starting | ||
| (MSC service thread 1-16) Camel context starting: cdi-context | ||
| (MSC service thread 1-6) Bound camel naming object: java:jboss/camel/context/cdi-context | ||
| (MSC service thread 1-16) Route: route4 started and consuming from: Endpoint[direct://start] | ||
| (MSC service thread 1-16) Total 1 routes, of which 1 is started | ||
| ``` | ||
| (MSC service thread 1-16) Apache Camel (CamelContext: cdi-context) is starting | ||
| (MSC service thread 1-16) Camel context starting: cdi-context | ||
| (MSC service thread 1-6) Bound camel naming object: java:jboss/camel/context/cdi-context | ||
| (MSC service thread 1-16) Route: route4 started and consuming from: Endpoint[direct://start] | ||
| (MSC service thread 1-16) Total 1 routes, of which 1 is started | ||
|
|
||
|
|
||
| Access the application | ||
| ---------------------- | ||
|
|
||
| The application will be available at http://localhost:8080/your-context-root?name=Kermit | ||
|
|
||
|
|
||
| Undeploying the application | ||
| --------------------------- | ||
|
|
||
| mvn wildfly:undeploy | ||
|
|
||
|
|
||
| ${symbol_hash}${symbol_hash}${symbol_hash} Access the application | ||
| Further reading | ||
| --------------- | ||
|
|
||
| The application will be available at <http://localhost:8080/${artifactId}?name=Kermit> | ||
| WildFly Camel documentation | ||
|
|
||
| ${symbol_hash}${symbol_hash}${symbol_hash} Undeploying the application | ||
| http://wildflyext.gitbooks.io/wildfly-camel/content/ | ||
|
|
||
| `mvn wildfly:undeploy` | ||
|
|
||
| ${symbol_hash}${symbol_hash} Further reading | ||
| Apache Camel documentation | ||
|
|
||
| * [WildFly-Camel documentation] (https://www.gitbook.com/book/wildflyext/wildfly-camel) | ||
| * [Apache Camel documentation] (http://camel.apache.org/) | ||
| http://camel.apache.org/ |
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
87 changes: 54 additions & 33 deletions
87
archetypes/archetype-spring/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 |
|---|---|---|
| @@ -1,77 +1,98 @@ | ||
| #set( $symbol_hash = '#' ) | ||
| ${symbol_hash} ${artifactId} | ||
| WildFly Camel Spring XML Web Application | ||
| ============= | ||
|
|
||
| This is a template Apache Camel Spring application for the WildFly-Camel subsystem. | ||
| This is a template Apache Camel Spring application for the WildFly Camel subsystem. | ||
|
|
||
| This project is setup to allow you to create a Apache Camel Spring application, which can be deployed to an application | ||
| server running the WildFly-Camel subsystem. An example Spring XML Camel Route has been created for you, together with an Arquillian | ||
| server running the WildFly Camel subsystem. An example Spring XML Camel Route has been created for you, together with an Arquillian | ||
| integration test. | ||
|
|
||
| ${symbol_hash}${symbol_hash} Prerequisites | ||
| Prerequisites | ||
| ============= | ||
|
|
||
| * Minimum of Java 1.7 | ||
| * Maven 3.2 or greater | ||
| * WildFly application server version ${version-wildfly} | ||
| * WildFly application server. Refer to the WildFly Camel compatibility matrix for more information. | ||
|
|
||
| ${symbol_hash}${symbol_hash} Getting started | ||
| http://wildflyext.gitbooks.io/wildfly-camel/content/start/compatibility.html | ||
|
|
||
| 1. Install WildFly-Camel subsystem distribution version ${version} on your application server | ||
|
|
||
| 2. Conifgure a `$JBOSS_HOME` environment variable to point at your application server installation directory | ||
| Getting started | ||
| --------------- | ||
|
|
||
| 1. Install the WildFly Camel subsystem distribution on your application server | ||
|
|
||
| 2. Configure a $JBOSS_HOME environment variable to point at your application server installation directory | ||
|
|
||
| 3. Start the application server from the command line | ||
|
|
||
| For Linux: | ||
|
|
||
| `$JBOSS_HOME/bin/standalone.sh -c standalone-camel.xml` | ||
| $JBOSS_HOME/bin/standalone.sh -c standalone-camel.xml | ||
|
|
||
| For Windows: | ||
|
|
||
| `%JBOSS_HOME%\bin\standalone.bat -c standalone-camel.xml` | ||
| %JBOSS_HOME%\bin\standalone.bat -c standalone-camel.xml | ||
|
|
||
|
|
||
| ${symbol_hash}${symbol_hash}${symbol_hash} Building the application | ||
| Building the application | ||
| ------------------------ | ||
|
|
||
| To build the application do: | ||
|
|
||
| `mvn clean install` | ||
| mvn clean install | ||
|
|
||
| ${symbol_hash}${symbol_hash}${symbol_hash} Run Arquillian Tests | ||
|
|
||
| Run Arquillian Tests | ||
| -------------------- | ||
|
|
||
| By default, tests are configured to be skipped as Arquillian requires the use of a container. | ||
|
|
||
| If you already have a running application server, you can run integration tests with: | ||
|
|
||
| `mvn clean test -Parq-remote` | ||
| mvn clean test -Parq-remote | ||
|
|
||
| Otherwise you can get Arquillian to start and stop the server for you (Note: you must have $JBOSS_HOME configured beforehand): | ||
|
|
||
| Otherwise you can get Arquillian to start and stop the server for you (Note: you must have `JBOSS_HOME` configured beforehand): | ||
| mvn clean test -Parq-managed | ||
|
|
||
| `mvn clean test -Parq-managed` | ||
|
|
||
| ${symbol_hash}${symbol_hash}${symbol_hash} Deploying the application | ||
| Deploying the application | ||
| ------------------------- | ||
|
|
||
| To deploy the application to a running application server do: | ||
|
|
||
| `mvn clean package wildfly:deploy` | ||
| mvn clean package wildfly:deploy | ||
|
|
||
| The server console should display lines like the following: | ||
|
|
||
| ``` | ||
| (MSC service thread 1-16) Apache Camel (CamelContext: spring-context) is starting | ||
| (MSC service thread 1-16) Camel context starting: spring-context | ||
| (MSC service thread 1-6) Bound camel naming object: java:jboss/camel/context/spring-context | ||
| (MSC service thread 1-16) Route: route4 started and consuming from: Endpoint[direct://start] | ||
| (MSC service thread 1-16) Total 1 routes, of which 1 is started | ||
| ``` | ||
| (MSC service thread 1-16) Apache Camel (CamelContext: spring-context) is starting | ||
| (MSC service thread 1-16) Camel context starting: spring-context | ||
| (MSC service thread 1-6) Bound camel naming object: java:jboss/camel/context/spring-context | ||
| (MSC service thread 1-16) Route: route4 started and consuming from: Endpoint[direct://start] | ||
| (MSC service thread 1-16) Total 1 routes, of which 1 is started | ||
|
|
||
|
|
||
| Access the application | ||
| ---------------------- | ||
|
|
||
| The application will be available at http://localhost:8080/your-context-root?name=Kermit | ||
|
|
||
|
|
||
| Undeploying the application | ||
| --------------------------- | ||
|
|
||
| mvn wildfly:undeploy | ||
|
|
||
|
|
||
| ${symbol_hash}${symbol_hash}${symbol_hash} Access the application | ||
| Further reading | ||
| --------------- | ||
|
|
||
| The application will be available at <http://localhost:8080/${artifactId}?name=Kermit> | ||
| WildFly Camel documentation | ||
|
|
||
| ${symbol_hash}${symbol_hash}${symbol_hash} Undeploying the application | ||
| http://wildflyext.gitbooks.io/wildfly-camel/content/ | ||
|
|
||
| `mvn wildfly:undeploy` | ||
|
|
||
| ${symbol_hash}${symbol_hash} Further reading | ||
| Apache Camel documentation | ||
|
|
||
| * [WildFly-Camel documentation] (https://www.gitbook.com/book/wildflyext/wildfly-camel) | ||
| * [Apache Camel documentation] (http://camel.apache.org/) | ||
| http://camel.apache.org/ |
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