JBEAP-14084: Create shared content - Pulled out more common content i…

…nto shared docs; restructured Configure the Server sections to be consistent in backup, starting the server, configuration, restore
wildfly · Jan 29, 2018 · 401bd7f · 401bd7f
1 parent 7de01c4
commit 401bd7f
Show file tree

Hide file tree

Showing 74 changed files with 919 additions and 1,305 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 *~
+build
 target
 .DS_Store
 bin

diff --git a/README.adoc b/README.adoc
@@ -4,7 +4,7 @@
 :jbossHomeName: WILDFLY_HOME
 :productVersion: 12
 :ext-relative: {outfilesuffix}
-include::attributes.adoc[]
+include::shared-doc/attributes.adoc[]
 
 [abstract]
 The quickstarts demonstrate Java EE 7 and a few additional technologies from the JBoss stack. They provide small, specific, working examples that can be used as a reference for your own project.
@@ -48,7 +48,7 @@ NOTE: Some of these quickstarts use the H2 database included with {productName}.
 [cols="1,1,2,1,1", options="header"]
 |===
 | Quickstart Name | Demonstrated Technologies | Description | Experience Level Required | Prerequisites 
-| link:app-client/README{outfilesuffix}[app-client]|EJB, EAR, AppClient | The `app-client` quickstart demonstrates how to code and package a client app and use the {productName} client container to start the client Main program. | Intermediate | _none_
+| link:app-client/README{outfilesuffix}[app-client]|EJB, EAR, AppClient | The `app-client` quickstart demonstrates how to code and package a client app and use the {productName} client container to start the client `Main` program. | Intermediate | _none_
 | link:batch-processing/README{outfilesuffix}[batch-processing]|CDI, Batch 1.0, JSF | The `batch-processing` quickstart shows how to use chunk oriented batch jobs to import a file to a database. | Intermediate | _none_
 | link:bean-validation/README{outfilesuffix}[bean-validation]|CDI, JPA, BV | The `bean-validation` quickstart provides Arquillian tests to demonstrate how to use CDI, JPA, and Bean Validation. | Beginner | _none_
 | link:bean-validation-custom-constraint/README{outfilesuffix}[bean-validation-custom-constraint]|CDI, JPA, BV | The `bean-validation-custom-constraint` quickstart demonstrates how to use the Bean Validation API to define custom constraints and validators. | Beginner | _none_

diff --git a/app-client/README.adoc b/app-client/README.adoc
@@ -12,7 +12,7 @@ include::../shared-doc/attributes.adoc[]
 :source: {githubRepoUrl}
 
 [abstract]
-The `app-client` quickstart demonstrates how to code and package a client app and use the {productName} client container to start the client Main program.
+The `app-client` quickstart demonstrates how to code and package a client app and use the {productName} client container to start the client `Main` program.
 
 == What is it?
 
@@ -82,7 +82,7 @@ include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1]
 
 == Build and Deploy the Quickstart
 
-. Make sure you have started the {productName} server as described above.
+. Make sure you xref:start_eap_standalone_server_with_the_default_profile[start the {productName} server with the standalone default profile] as described above.
 . Open a terminal and navigate to the root directory of this quickstart.
 . Type the following command to build the artifacts.
 +

diff --git a/batch-processing/README.adoc b/batch-processing/README.adoc
@@ -186,12 +186,8 @@ $ mvn wildfly:undeploy
 
 You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use JBoss Developer Studio or Eclipse to Run the Quickstarts].
 
-[[debug_the_application]]
-== Debug the Application
-
-If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
-
-[source,options="nowrap"]
-----
-$ mvn dependency:sources
-----
+//*************************************************
+// Add info to debug the application
+//*************************************************
+// == Debug the Application
+include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
diff --git a/bean-validation-custom-constraint/README.adoc b/bean-validation-custom-constraint/README.adoc
@@ -98,17 +98,19 @@ HHH000431: Unable to determine H2 database version, certain features may not wor
 
 You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use JBoss Developer Studio or Eclipse to Run the Quickstarts].
 
-== Debug the Application
-
-If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
-
-----
-$ mvn dependency:sources
-----
+//*************************************************
+// Add info to debug the application
+//*************************************************
+// == Debug the Application
+include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
 
+// Additional debugging information
+[NOTE]
+====
 You might see the following message when you run the command. It indicates the source is not provided in the third-party `antlr` JAR.
 
 ----
 [INFO] The following files have NOT been resolved:
 [INFO]    antlr:antlr:jar:sources:2.7.7:provided
 ----
+====
diff --git a/bean-validation/README.adoc b/bean-validation/README.adoc
@@ -99,10 +99,8 @@ HHH000431: Unable to determine H2 database version, certain features may not wor
 
 You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use JBoss Developer Studio or Eclipse to Run the Quickstarts].
 
-== Debug the Application
-
-If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
-
-----
-$ mvn dependency:sources
-----
+//*************************************************
+// Add info to debug the application
+//*************************************************
+// == Debug the Application
+include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
diff --git a/bmt/README.adoc b/bmt/README.adoc
@@ -101,10 +101,8 @@ $ mvn wildfly:undeploy
 
 You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use JBoss Developer Studio or Eclipse to Run the Quickstarts].
 
-== Debug the Application
-
-If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
-
-----
-$ mvn dependency:sources
-----
+//*************************************************
+// Add info to debug the application
+//*************************************************
+// == Debug the Application
+include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
diff --git a/buildReadmes.sh b/buildReadmes.sh
@@ -6,7 +6,7 @@ NO_COLOR="\033[0m"
 
 usage(){
   cat <<EOM
-Run this script from the root of your cloned repository: 
+Run this script from the root of your cloned repository:
 
   ~/eap-quickstarts $ ./buildReadmes.sh
 EOM
@@ -49,4 +49,3 @@ else
     echo -e "${RED}Please fix all issues before requesting a merge!${NO_COLOR}"
     exit 1;
 fi
-
diff --git a/cmt/README.adoc b/cmt/README.adoc
@@ -126,10 +126,8 @@ You can also start the server and deploy the quickstarts or run the Arquillian t
 
 NOTE: Within JBoss Developer Studio, make sure you define a server runtime environment that uses the `standalone-full.xml` configuration file.
 
-== Debug the Application
-
-If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
-
-----
-$ mvn dependency:sources
-----
+//*************************************************
+// Add info to debug the application
+//*************************************************
+// == Debug the Application
+include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
diff --git a/ejb-asynchronous/README.adoc b/ejb-asynchronous/README.adoc
@@ -130,11 +130,8 @@ This quickstart consists of multiple projects, so it deploys and runs differentl
 ** The client output displays in the *Console* window.
 . To undeploy the project, right-click on the *{artifactId}-ejb* project and choose *Run As* -> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*.
 
-== Debug the Application
-
-If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
-
-[source,options="nowrap"]
-----
-$ mvn dependency:sources
-----
+//*************************************************
+// Add info to debug the application
+//*************************************************
+// == Debug the Application
+include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
diff --git a/ejb-in-ear/README.adoc b/ejb-in-ear/README.adoc
@@ -104,11 +104,8 @@ For this quickstart, follow the special instructions to build link:{useEclipseDe
 . This starts the server, deploys the application, and opens a browser window that accesses the running application.
 . To undeploy the project, right-click on the *{artifactId}-ear* project and choose *Run As* -> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*.
 
-== Debug the Application
-
-If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
-
-[source,options="nowrap"]
-----
-$ mvn dependency:sources
-----
+//*************************************************
+// Add info to debug the application
+//*************************************************
+// == Debug the Application
+include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
diff --git a/ejb-in-war/README.adoc b/ejb-in-war/README.adoc
@@ -111,10 +111,8 @@ INFO  [org.jboss.as.server] (management-handler-thread - 30) WFLYSRV0009: Undepl
 
 You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use JBoss Developer Studio or Eclipse to Run the Quickstarts].
 
-== Debug the Application
-
-If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
-
-----
-$ mvn dependency:sources
-----
+//*************************************************
+// Add info to debug the application
+//*************************************************
+// == Debug the Application
+include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
diff --git a/ejb-multi-server/README.adoc b/ejb-multi-server/README.adoc
@@ -275,10 +275,8 @@ NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat`.
 
 EJB Client (ejb-client) currently has limited support in the Eclipse Web Tools Platform (WTP). For that reason, this quickstart is not supported in Red Hat JBoss Developer Studio.
 
-== Debug the Application
-
-If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
-
-----
-$ mvn dependency:sources
-----
+//*************************************************
+// Add info to debug the application
+//*************************************************
+// == Debug the Application
+include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
-Original file line number
+Diff line change
@@ -1,4 +1,5 @@
     *~
+    build
     target
     .DS_Store
     bin
@@ Expand Down @@