JBEAP-14084-part7: More consolidation of common instructions

junquero · Feb 1, 2018 · 5529302 · 5529302
1 parent 914b1d5
commit 5529302
Show file tree

Hide file tree

Showing 96 changed files with 962 additions and 344 deletions.
diff --git a/batch-processing/README.adoc b/batch-processing/README.adoc
@@ -172,11 +172,11 @@ HHH000431: Unable to determine H2 database version, certain features may not wor
 // == Undeploy the Quickstart
 include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1]
 
-
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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].
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
 //*************************************************
 // Add info to debug the application

diff --git a/bean-validation-custom-constraint/README.adoc b/bean-validation-custom-constraint/README.adoc
@@ -88,10 +88,11 @@ WFLYJCA0091: -ds.xml file deployments are deprecated. Support may be removed in
 HHH000431: Unable to determine H2 database version, certain features may not work
 ----
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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].
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
 //*************************************************
 // Add info to debug the application

diff --git a/bean-validation/README.adoc b/bean-validation/README.adoc
@@ -90,10 +90,11 @@ WFLYJCA0091: -ds.xml file deployments are deprecated. Support may be removed in
 HHH000431: Unable to determine H2 database version, certain features may not work
 ----
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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].
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
 //*************************************************
 // Add info to debug the application

diff --git a/bmt/README.adoc b/bmt/README.adoc
@@ -90,10 +90,11 @@ HHH000431: Unable to determine H2 database version, certain features may not wor
 include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1]
 
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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].
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
 //*************************************************
 // Add info to debug the application

diff --git a/cmt/README.adoc b/cmt/README.adoc
@@ -113,13 +113,16 @@ HHH000431: Unable to determine H2 database version, certain features may not wor
 include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1]
 
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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].
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
+// Additional JBoss Developer Studio instructions
 NOTE: Within JBoss Developer Studio, make sure you define a server runtime environment that uses the `standalone-full.xml` configuration file.
 
+
 //*************************************************
 // Add info to debug the application
 //*************************************************

diff --git a/contacts-jquerymobile/README.adoc b/contacts-jquerymobile/README.adoc
@@ -161,11 +161,12 @@ For more information on QUnit tests, see http://qunitjs.com/.
 // == Run the Arquillian Functional Tests
 include::../shared-doc/run-arquillian-functional-tests.adoc[leveloffset=+1]
 
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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
 

diff --git a/ejb-asynchronous/README.adoc b/ejb-asynchronous/README.adoc
@@ -110,12 +110,13 @@ action 'fireAndForget' finished
 // == Undeploy the Quickstart
 include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1]
 
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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].
-
+// Additional JBoss Developer Studio instructions
 This quickstart consists of multiple projects, so it deploys and runs differently in JBoss Developer Studio than the other quickstarts.
 
 . Install the required Maven artifacts and deploy the asynchronous EJB quickstart project.

diff --git a/ejb-in-ear/README.adoc b/ejb-in-ear/README.adoc
@@ -85,11 +85,13 @@ Enter a name in the input field and click the *Greet* button to see the response
 include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1]
 
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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].
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
+// Additional JBoss Developer Studio instructions
 For this quickstart, follow the special instructions to build link:{useEclipseDeployEARDocUrl}[Quickstarts Containing an EAR].
 
 . Right-click on the *{artifactId}-ear* subproject, and choose *Run As* -> *Run on Server*.

diff --git a/ejb-in-war/README.adoc b/ejb-in-war/README.adoc
@@ -92,10 +92,12 @@ INFO  [org.jboss.as.server] (management-handler-thread - 29) WFLYSRV0010: Deploy
 INFO  [org.jboss.as.server] (management-handler-thread - 30) WFLYSRV0009: Undeployed "test.war" (runtime-name: "test.war")
 ----
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
-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].
 
 //*************************************************
 // Add info to debug the application

diff --git a/ejb-multi-server/README.adoc b/ejb-multi-server/README.adoc
@@ -16,6 +16,8 @@ The `ejb-multi-server` quickstart shows how to communicate between multiple appl
 
 :managed-domain-type: default
 :archiveType: ear
+:includes-cli-scripts:
+:jbds-not-supported:
 
 == What is it?
 
@@ -50,7 +52,6 @@ The server configuration is done using CLI batch scripts located in the root of
 // Add System Requirements
 //*************************************************
 // == System Requirements
-:includes-cli-scripts:
 include::../shared-doc/system-requirements.adoc[leveloffset=+1]
 
 //*************************************************
@@ -102,7 +103,7 @@ include::../shared-doc/back-up-managed-domain-configuration.adoc[leveloffset=+1]
 // Start the managed domain
 //*************************************************
 // == Start the {productName} Managed Domain
-include::../shared-doc/start-server-managed-domain.adoc[leveloffset=+1]
+include::../shared-doc/start-the-managed-domain.adoc[leveloffset=+1]
 
 [[configure_the_server]]
 == Configure the Server
@@ -268,11 +269,14 @@ NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat`.
 // == Restore the {productName} Managed Domain Configuration Manually
 include::../shared-doc/restore-managed-domain-configuration-manual.adoc[leveloffset=+1]
 
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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.
+// Additional JBoss Developer Studio instructions
+EJB Client (ejb-client) currently has limited support in the Eclipse Web Tools Platform (WTP).
 
 //*************************************************
 // Add info to debug the application

diff --git a/ejb-remote/README.adoc b/ejb-remote/README.adoc
@@ -133,7 +133,7 @@ The output in the terminal window will look like the following:
 
 Logging statements have been removed from this output here to make it clearer.
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
+[[build_and_run_the_quickstart_as_an_executable_jar]]
 == Build and Run The Quickstart as an Executable JAR
 
 The remote client application can also be built as a standalone executable JAR with all of its dependencies.
@@ -173,10 +173,30 @@ $ cd ../server-side
 $ mvn wildfly:undeploy
 ----
 
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+== Using EJB over HTTP
+
+You can use HTTP as the transport for remote EJB invocations by specifying `-Dhttp=true` on both the Maven and command line based execution. This should not change the output, but it will use EJB over HTTP for the invocations. This means that each EJB request maps to a single HTTP request (actually HTTP/2 by default, if it is enabled on the server).
+
+Before you can use it, you need to set up a user on the server as HTTP does not support transparent authentication.
+
+To add the user, open a terminal and type the following command.
+
+[source,subs="+quotes,attributes+",options="nowrap"]
+----
+$ __{jbossHomeName}__/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!'
+----
+
+NOTE: For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script.
 
-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].
+If you prefer, you can use the `add-user` utility interactively. For an example of how to use the add-user utility, see the instructions located here: link:{addApplicationUserDocUrl}[Add an Application User].
 
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
+
+// Additional JBoss Developer Studio instructions
 This quickstart consists of multiple projects, so it deploys and runs differently in JBoss Developer Studio than the other quickstarts.
 
 . Install the required Maven artifacts and deploy the server side of the quickstart project.
@@ -197,20 +217,3 @@ If you want to debug the source code of any library in the project, run the foll
 ----
 mvn dependency:sources
 ----
-
-== Using EJB over HTTP
-
-You can use EJB over HTTP by specifying -Dhttp=true to both the maven and command line based execution. This should not change
-the output, but will use EJB over HTTP for the invocations. This means that each EJB request maps to a single HTTP
-request (actually HTTP/2 by default, if it is enabled on the server).
-
-Before you can use this however you need to setup a user on the server, as HTTP does not support transparent auth.
-
-[subs="+quotes,attributes+"]
-----
-For Linux:
-  $JBOSS_HOME/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!'
-
-For Windows:
-  %JBOSS_HOME%\bin\add-user.bat  -a -u 'quickstartUser' -p 'quickstartPwd1!'
-----
diff --git a/ejb-security-context-propagation/README.adoc b/ejb-security-context-propagation/README.adoc
@@ -16,6 +16,7 @@ The `ejb-security-context-propagation` quickstart demonstrates how the security
 
 :standalone-server-type: default
 :archiveType: jar
+:includes-cli-scripts:
 
 == What is it?
 
@@ -66,7 +67,6 @@ For the purpose of this quickstart, we make use of a loopback connection to the
 // Add System Requirements
 //*************************************************
 // == System Requirements
-:includes-cli-scripts:
 include::../shared-doc/system-requirements.adoc[leveloffset=+1]
 
 //*************************************************
@@ -366,11 +366,13 @@ The batch executed successfully
 // == Restore the {productName} Standalone Server Configuration Manually
 include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2]
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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].
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
+// Additional JBoss Developer Studio instructions
 This quickstart requires additional configuration and deploys and runs differently in JBoss Developer Studio than the other quickstarts.
 
 . Make sure you xref:add_the_application_users[Add the Application Users] as described above.

diff --git a/ejb-security-jaas/README.adoc b/ejb-security-jaas/README.adoc
@@ -16,6 +16,7 @@ The `ejb-security-jaas` quickstart demonstrates how legacy `JAAS` security domai
 
 :standalone-server-type: default
 :archiveType: war
+:includes-cli-scripts:
 
 == What is it?
 
@@ -34,7 +35,6 @@ The following steps required to use the `JAAS` integration.
 // Add System Requirements
 //*************************************************
 // == System Requirements
-:includes-cli-scripts:
 include::../shared-doc/system-requirements.adoc[leveloffset=+1]
 
 //*************************************************
@@ -349,11 +349,13 @@ include::../shared-doc/restore-standalone-server-configuration-manual.adoc[level
 After you are done with this quickstart, remember to remove the `users.properties` and `roles.properties` files from the
 server configuration directory (`__{jbossHomeName}__/standalone/configuration/`).
 
-[[run_the_quickstart_in_jboss_developer_studio_or_eclipse]]
-== Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
-
-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].
+//*************************************************
+// Add JBoss Developer Studio instructions
+//*************************************************
+// == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
+include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
 
+// Additional JBoss Developer Studio instructions
 * Make sure you xref:create_the_properties_files_for_the_jaas_security_domain[Create the Properties Files for the JAAS Security Domain] as described above.
 * Make sure you configure the server by running the JBoss CLI script as described above under xref:configure_the_server[Configure the Server]. Stop the server at the end of that step.
 * To deploy the application to the {productName} server, right-click on the *{artifactId}* project and choose *Run As* -> *Run on Server*.