Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions shared-doc/install-quickstart-parent-artifact.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
// The product release and tagged downloads of the wildfly quickstarts
// install the the quickstart parent artifact.
// It is only necessary to install the parent artifact if you are working with the current
// quickstart source in GitHub.

ifndef::ProductRelease[]
[[install_the_quickstart_parent_artifact_in_maven]]
= Install the Quickstart Parent Artifact in Maven
//******************************************************************************
// Include this template if your quickstart requires the installation of
// the quickstart parent artifact.
// We do not have a way of determining whether someone is working with a
// WildFly tagged release or with the currenct quickstart source, so we add
// a note instead.
//******************************************************************************

NOTE: The `quickstart-parent` artifact is already installed to Maven for tagged releases of the quickstarts. If you using a tagged release that you downloaded from the {githubRepoUrl}[WildFly quickstart repository], you can skip this step.

This quickstart requires the `quickstart-parent` artifact to be installed in your local Maven repository. To install it, navigate to your __QUICKSTART_HOME__ directory directory and run the following command.

[source,subs="+quotes,attributes+",options="nowrap"]
----
$ cd __QUICKSTART_HOME__
$ mvn clean install
----
// end ifndef::ProductReleasae[]
endif::[]
12 changes: 9 additions & 3 deletions shared-doc/use-of-jboss-home-name.adoc
Original file line number Diff line number Diff line change
@@ -1,24 +1,30 @@
ifdef::requires-multiple-servers[]
[[use_of_jboss_home_name]]
= Use of {jbossHomeName}_1 and {jbossHomeName}_2
= Use of the {jbossHomeName}_1, {jbossHomeName}_2, and QUICKSTART_HOME Variables

This quickstart requires that you clone your `__{jbossHomeName}__` installation directory and run two servers. The installation path is described in detail here: link:{useProductHomeDocUrl}[Use of __{jbossHomeName}__ and __JBOSS_HOME__ Variables].

In the following instructions, replace `__{jbossHomeName}_1__` with the path to your first {productName} server and replace `__{jbossHomeName}_2__` with the path to your second cloned {productName} server.

When you see the replaceable variable __QUICKSTART_HOME__, replace it with the path to the root directory of all of the quickstarts.
endif::[]

ifdef::optional-domain-or-multiple-servers[]
[[use_of_jboss_home_name]]
= Use of {jbossHomeName}_1 and {jbossHomeName}_2
= Use of the {jbossHomeName}_1, {jbossHomeName}_2, and QUICKSTART_HOME Variables

When deploying this quickstart to a managed domain, replace `__{jbossHomeName}__` with the actual path to your {productName} installation. The installation path is described in detail here: link:{useProductHomeDocUrl}[Use of __{jbossHomeName}__ and __JBOSS_HOME__ Variables].

When deploying this quickstart to multiple standalone servers, this quickstart requires that you clone your `__{jbossHomeName}__` installation directory and run two servers. In the following instructions, replace `__{jbossHomeName}_1__` with the path to your first {productName} server and replace `__{jbossHomeName}_2__` with the path to your second cloned {productName} server.

When you see the replaceable variable __QUICKSTART_HOME__, replace it with the path to the root directory of all of the quickstarts.
endif::[]

ifndef::requires-multiple-servers,optional-domain-or-multiple-servers[]
[[use_of_jboss_home_name]]
= Use of {jbossHomeName}
= Use of the {jbossHomeName} and QUICKSTART_HOME Variables

In the following instructions, replace `__{jbossHomeName}__` with the actual path to your {productName} installation. The installation path is described in detail here: link:{useProductHomeDocUrl}[Use of __{jbossHomeName}__ and __JBOSS_HOME__ Variables].

When you see the replaceable variable __QUICKSTART_HOME__, replace it with the path to the root directory of all of the quickstarts.
endif::[]
4 changes: 3 additions & 1 deletion template/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,9 @@ Point out the changes made after running the CLI script.

Add this section if the quickstart requires installation of the quickstart parent artifact into Maven.

This topic is located in the `shared-docs/install-quickstart-parent-artifact.adoc` file. Include this file using the following syntax.
This topic is located in the `shared-docs/install-quickstart-parent-artifact.adoc` file. This step is never needed for a product release, so the topic includes conditional syntax to prevent its inclusion in that case. It is also not needed for tagged downloads, but since there is no easy way to test for that condition, it includes a note instead.

Include this file using the following syntax.

.Example: include::../shared-doc/install-quickstart-parent-artifact.adoc
[source,options="nowrap"]
Expand Down