Merge pull request wildfly#18338 from bstansberry/WFLY-15590

[WFLY-15590] Add READMEs for the 'galleon-shared' and 'galleon-local'…

ee-feature-pack/galleon-local/README.adoc

@@ -0,0 +1,54 @@
+= Use of wildfly-ee-feature-pack-galleon-local
+:icons: font
+:source-highlighter: coderay
+
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
+
+== Overview
+
+The `wildfly-ee-feature-pack-galleon-local` module is used to control the source code and dependency management for items that
+are relevant to the `wildfly-ee` feature pack *but not* to the `wildfly-preview` feature pack.
+
+[WARNING]
+====
+If something is relevant to some other feature pack besides `wildfly-ee`, *DO NOT* include it here.
+
+* If it's relevant to *both* the `wildfly-ee` and the `wildfly-preview` feature packs, use the `wildfly-ee-feature-pack-galleon-shared` maven module.
+* If it's only for `wildfly-preview`, use the `wildfly-preview-feature-pack-galleon-local` maven module.
+* If it's relevant to standard WildFly but only if the `wildfly` feature pack is used, use either the `wildfly-feature-pack-galleon-shared` or `wildfly-feature-pack-galleon-local` maven module.
+====
+
+This module is a dependency of the `wildfly-ee-galleon-pack` maven module. Its content and dependency entries are used by the build of that module when it creates its feature pack.
+
+== Galleon Content
+
+Galleon content refers to content other than maven artifacts that Galleon provisions. This includes:
+
+* Files that are directly provisioned. The primary example here is `module.xml` files, along with the directory structure in which they are found.
+** The `module.xml` files and their directory structure go in the `modules` folder.
+** Other content, including the relevant directory structure, goes in the `content` folder.
+* Configuration generation instructions. These are found in `configs`, `feature_groups` and `layers` folders.
+* Explicit Galleon package content, found in folders under the `packages` folder.
+
+== Dependency Management
+
+The `pom.xml` file for this module *must* include `dependency` entries for all artifacts mentioned in the `module.xml` files included in this maven module. It *must not* include `dependency` entries for other artifacts.
+
+The build of the `wildfly-ee-galleon-pack` maven module relies on the dependency information in this pom to tell it what artifacts the feature pack should include.  Missing information will break the build. Extraneous information may result in the feature pack provisioning the wrong version of artifacts.
+
+== Licenses
+
+If the wildfly-license-plugin needs special instructions to identify the license used by an artifact declared in this module's `pom.xml`, that information *must* be included in the `src/main/resources/license/licenses.xml` file. This is expected to be an uncommon situation.
+
+== Build Output
+
+The build of this feature pack produces a zip that basically packages the content. This is for two reasons:
+
+* Nexus balks at this module not producing an artifact, preventing deploying.
+* Ideally, the `wildfly-ee-galleon-pack` maven module would depend on and unzip these zip artifacts and consume their content that way. But, at least at the time this document was written, it doesn't do this and instead just copies in source from this maven module.

ee-feature-pack/galleon-shared/README.adoc

@@ -0,0 +1,55 @@
+= Use of wildfly-ee-feature-pack-galleon-shared
+:icons: font
+:source-highlighter: coderay
+
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
+
+== Overview
+
+The `wildfly-ee-feature-pack-galleon-shared` module is used to control the source code and dependency management for items that
+are relevant to *both* the `wildfly-ee` and `wildfly-preview` feature
+packs.
+
+[WARNING]
+====
+If something is only relevant to one of `wildfly-ee` *or* `wildfly-preview`, *DO NOT* include it here.
+
+* If it's only for `wildfly-ee`, use the `wildfly-ee-feature-pack-galleon-local` maven module.
+* If it's only for `wildfly-preview`, use the `wildfly-preview-feature-pack-galleon-local` maven module.
+* If it's relevant to standard WildFly but only if the `wildfly` feature pack is used, use either the `wildfly-feature-pack-galleon-shared` or `wildfly-feature-pack-galleon-local` maven module.
+====
+
+This module is a dependency of both the `wildfly-ee-galleon-pack` and the `wildfly-preview-feature-pack` maven modules. Its content and dependency entries are used by the build of those modules when they create their respective feature packs.
+
+== Galleon Content
+
+Galleon content refers to content other than maven artifacts that Galleon provisions. This includes:
+
+* Files that are directly provisioned. The primary example here is `module.xml` files, along with the directory structure in which they are found.
+** The `module.xml` files and their directory structure go in the `modules` folder.
+** Other content, including the relevant directory structure, goes in the `content` folder.
+* Configuration generation instructions. These are found in `configs`, `feature_groups` and `layers` folders.
+* Explicit Galleon package content, found in folders under the `packages` folder.
+
+== Dependency Management
+
+The `pom.xml` file for this module *must* include `dependency` entries for all artifacts mentioned in the `module.xml` files included in this maven module. It *must not* include `dependency` entries for other artifacts.
+
+The build of the `wildfly-ee-galleon-pack` and the `wildfly-preview-feature-pack` maven modules relies on the dependency information in this pom to tell it what artifacts the feature pack should include.  Missing information will break the build. Extraneous information may result in the feature pack provisioning the wrong version of artifacts.
+
+== Licenses
+
+If the wildfly-license-plugin needs special instructions to identify the license used by an artifact declared in this module's `pom.xml`, that information *must* be included in the `src/main/resources/license/licenses.xml` file. This is expected to be an uncommon situation.
+
+== Build Output
+
+The build of this feature pack produces a zip that basically packages the content. This is for two reasons:
+
+* Nexus balks at this module not producing an artifact, preventing deploying.
+* Ideally, the `wildfly-ee-galleon-pack` and the `wildfly-preview-feature-pack` maven modules would depend on and unzip these zip artifacts and consume their content that way. But, at least at the time this document was written, they don't do this and instead just copy in source from this maven module.

galleon-pack/galleon-local/README.adoc

@@ -0,0 +1,54 @@
+= Use of wildfly-feature-pack-galleon-local
+:icons: font
+:source-highlighter: coderay
+
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
+
+== Overview
+
+The `wildfly-feature-pack-galleon-local` module is used to control the source code and dependency management for items that
+are relevant to the `wildfly` feature pack *but not* to the `wildfly-preview` feature pack.
+
+[WARNING]
+====
+If something is relevant to some other feature pack besides `wildfly`, *DO NOT* include it here.
+
+* If it's relevant to *both* the `wildfly` and the `wildfly-preview` feature packs, use the `wildfly-feature-pack-galleon-shared` maven module.
+* If it's only for `wildfly-preview`, use the `wildfly-preview-feature-pack-galleon-local` maven module.
+* If it's relevant to standard WildFly but needs to be provisioned when *only* the `wildfly-ee` feature pack is used, use either the `wildfly-ee-feature-pack-galleon-shared` or `wildfly-ee-feature-pack-galleon-local` maven module.
+====
+
+This module is a dependency of the `wildfly-galleon-pack` maven module. Its content and dependency entries are used by the build of that module when it creates its feature pack.
+
+== Galleon Content
+
+Galleon content refers to content other than maven artifacts that Galleon provisions. This includes:
+
+* Files that are directly provisioned. The primary example here is `module.xml` files, along with the directory structure in which they are found.
+** The `module.xml` files and their directory structure go in the `modules` folder.
+** Other content, including the relevant directory structure, goes in the `content` folder.
+* Configuration generation instructions. These are found in `configs`, `feature_groups` and `layers` folders.
+* Explicit Galleon package content, found in folders under the `packages` folder.
+
+== Dependency Management
+
+The `pom.xml` file for this module *must* include `dependency` entries for all artifacts mentioned in the `module.xml` files included in this maven module. It *must not* include `dependency` entries for other artifacts.
+
+The build of the `wildfly-galleon-pack` maven module relies on the dependency information in this pom to tell it what artifacts the feature pack should include.  Missing information will break the build. Extraneous information may result in the feature pack provisioning the wrong version of artifacts.
+
+== Licenses
+
+If the wildfly-license-plugin needs special instructions to identify the license used by an artifact declared in this module's `pom.xml`, that information *must* be included in the `src/main/resources/license/licenses.xml` file. This is expected to be an uncommon situation.
+
+== Build Output
+
+The build of this feature pack produces a zip that basically packages the content. This is for two reasons:
+
+* Nexus balks at this module not producing an artifact, preventing deploying.
+* Ideally, the `wildfly-galleon-pack` maven module would depend on and unzip these zip artifacts and consume their content that way. But, at least at the time this document was written, it doesn't do this and instead just copies in source from this maven module.

galleon-pack/galleon-shared/README.adoc

@@ -0,0 +1,55 @@
+= Use of wildfly-feature-pack-galleon-shared
+:icons: font
+:source-highlighter: coderay
+
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
+
+== Overview
+
+The `wildfly-feature-pack-galleon-shared` module is used to control the source code and dependency management for items that
+are relevant to *both* the `wildfly` and `wildfly-preview` feature
+packs.
+
+[WARNING]
+====
+If something is only relevant to one of `wildfly` *or* `wildfly-preview`, *DO NOT* include it here.
+
+* If it's only for `wildfly`, use the `wildfly-feature-pack-galleon-local` maven module.
+* If it's only for `wildfly-preview`, use the `wildfly-preview-feature-pack-galleon-local` maven module.
+* If it's relevant to standard WildFly but needs to be provisioned when *only* the `wildfly-ee` feature pack is used, use either the `wildfly-ee-feature-pack-galleon-shared` or `wildfly-ee-feature-pack-galleon-local` maven module.
+====
+
+This module is a dependency of both the `wildfly-galleon-pack` and the `wildfly-preview-feature-pack` maven modules. Its content and dependency entries are used by the build of those modules when they create their respective feature packs.
+
+== Galleon Content
+
+Galleon content refers to content other than maven artifacts that Galleon provisions. This includes:
+
+* Files that are directly provisioned. The primary example here is `module.xml` files, along with the directory structure in which they are found.
+** The `module.xml` files and their directory structure go in the `modules` folder.
+** Other content, including the relevant directory structure, goes in the `content` folder.
+* Configuration generation instructions. These are found in `configs`, `feature_groups` and `layers` folders.
+* Explicit Galleon package content, found in folders under the `packages` folder.
+
+== Dependency Management
+
+The `pom.xml` file for this module *must* include `dependency` entries for all artifacts mentioned in the `module.xml` files included in this maven module. It *must not* include `dependency` entries for other artifacts.
+
+The build of the `wildfly-galleon-pack` and the `wildfly-preview-feature-pack` maven modules relies on the dependency information in this pom to tell it what artifacts the feature pack should include.  Missing information will break the build. Extraneous information may result in the feature pack provisioning the wrong version of artifacts.
+
+== Licenses
+
+If the wildfly-license-plugin needs special instructions to identify the license used by an artifact declared in this module's `pom.xml`, that information *must* be included in the `src/main/resources/license/licenses.xml` file. This is expected to be an uncommon situation.
+
+== Build Output
+
+The build of this feature pack produces a zip that basically packages the content. This is for two reasons:
+
+* Nexus balks at this module not producing an artifact, preventing deploying.
+* Ideally, the `wildfly-galleon-pack` and the `wildfly-preview-feature-pack` maven modules would depend on and unzip these zip artifacts and consume their content that way. But, at least at the time this document was written, they don't do this and instead just copy in source from this maven module.

preview/galleon-local/README.adoc

@@ -0,0 +1,53 @@
+= Use of wildfly-preview-feature-pack-galleon-local
+:icons: font
+:source-highlighter: coderay
+
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
+
+== Overview
+
+The `wildfly-preview-feature-pack-galleon-local` module is used to control the source code and dependency management for items that
+are relevant to the `wildfly-preview` feature pack *but not* to the `wildfly-ee` or `wildfly` feature packs.
+
+[WARNING]
+====
+If something is relevant to some other feature packs besides `wildfly-preview`, *DO NOT* include it here.
+
+* If it's relevant to standard WildFly even if only the `wildfly-ee` feature pack is used, use either the `wildfly-ee-feature-pack-galleon-shared` or `wildfly-ee-feature-pack-galleon-local` maven module.
+* If it's relevant to standard WildFly but only if the `wildfly` feature pack is used, use either the `wildfly-feature-pack-galleon-shared` or `wildfly-feature-pack-galleon-local` maven module.
+====
+
+This module is a dependency of the `wildfly-preview-feature-pack` maven module. Its content and dependency entries are used by the build of that module when it creates its feature pack.
+
+== Galleon Content
+
+Galleon content refers to content other than maven artifacts that Galleon provisions. This includes:
+
+* Files that are directly provisioned. The primary example here is `module.xml` files, along with the directory structure in which they are found.
+** The `module.xml` files and their directory structure go in the `modules` folder.
+** Other content, including the relevant directory structure, goes in the `content` folder.
+* Configuration generation instructions. These are found in `configs`, `feature_groups` and `layers` folders.
+* Explicit Galleon package content, found in folders under the `packages` folder.
+
+== Dependency Management
+
+The `pom.xml` file for this module *must* include `dependency` entries for all artifacts mentioned in the `module.xml` files included in this maven module. It *must not* include `dependency` entries for other artifacts.
+
+The build of the `wildfly-preview-feature-pack` maven module relies on the dependency information in this pom to tell it what artifacts the feature pack should include.  Missing information will break the build. Extraneous information may result in the feature pack provisioning the wrong version of artifacts.
+
+== Licenses
+
+If the wildfly-license-plugin needs special instructions to identify the license used by an artifact declared in this module's `pom.xml`, that information *must* be included in the `src/main/resources/license/licenses.xml` file. This is expected to be an uncommon situation.
+
+== Build Output
+
+The build of this feature pack produces a zip that basically packages the content. This is for two reasons:
+
+* Nexus balks at this module not producing an artifact, preventing deploying.
+* Ideally, the `wildfly-preview-feature-pack` maven module would depend on and unzip these zip artifacts and consume their content that way. But, at least at the time this document was written, it doesn't do this and instead just copies in source from this maven module.