From 90d79e8662715f7a0910e767bb811d5614ae2277 Mon Sep 17 00:00:00 2001 From: "James R. Perkins" Date: Tue, 23 Jul 2024 07:27:13 -0700 Subject: [PATCH] Use the correct header formats for the README and add a ToC. Signed-off-by: James R. Perkins --- wildfly-getting-started-archetype/README.adoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/wildfly-getting-started-archetype/README.adoc b/wildfly-getting-started-archetype/README.adoc index 7b5df316..c37c85be 100644 --- a/wildfly-getting-started-archetype/README.adoc +++ b/wildfly-getting-started-archetype/README.adoc @@ -1,8 +1,8 @@ -WildFly getting started archetype ------------------------------ += WildFly getting started archetype +:toc: [[introduction]] -==== Introduction +== Introduction This archetype creates a new WAR project which contains a simple Restful web service and a HTML page to call the web service. @@ -15,7 +15,7 @@ It is prepared for running Arquillian unit tests. More details can be found in the file "src/main/resources/archetype-resources/README.txt", which is end-user doc and added to the resulting project. [[newwildflyversion]] -==== New WildFly version +== New WildFly version To update this archetype to a new WildFly version: In file "pom.xml": @@ -36,7 +36,7 @@ In file "src/main/resources/archetype-resources/pom.xml": Also test whether the Arquillian unit test "SampleIT" still works, see below. [[build]] -==== Build +== Build To build the archetype, you need at least Java 11. Run this command: [source,options="nowrap"] ---- @@ -45,14 +45,14 @@ $ mvn clean install It will be installed to your local maven repository at "%USERHOME%/.m2/repository/org/wildfly/archetype/wildfly-getting-started-archetype/", and an entry will be added to "%USERHOME%/.m2/repository/archetype-catalog.xml". [[createproject]] -==== Create project from archetype +== Create project from archetype To create a new project from this archetype, use this maven command (replace dummy values for "groupId", "artifactId" and "version" with correct values): ---- $ mvn archetype:generate -DgroupId=my.project.org -DartifactId=sampleproject -Dversion=1.0-SNAPSHOT -DarchetypeGroupId=org.wildfly.archetype -DarchetypeArtifactId=wildfly-getting-started-archetype -DarchetypeVersion=28.0.0.Final-SNAPSHOT ---- [[testing]] -==== Test the archetype +== Test the archetype After having built the archetype, check whether both profiles "arq-remote" and "arq-managed" work. This is done by using scripts found in the directory "testing". * Profile "arq-managed": set variable JBOSS_HOME, then execute "runtest_managed.bat/.sh " (replace "" with the current archetype version)