This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/maven-remote-resources-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 6c49100 Rewrite documentation per ASD-STE100 Simplified Technical
English (#264)
6c49100 is described below
commit 6c491009589cd6945244ccb6ef1c3f70a0af5ca3
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Fri Oct 30 18:51:54 2026 +0000
Rewrite documentation per ASD-STE100 Simplified Technical English (#264)
* Rewrite documentation per ASD-STE100 Simplified Technical English
* Update index.apt.vm
* Update index.apt.vm
* Update faq.fml
* Update download.xml.vm
---------
Co-authored-by: opencode <[email protected]>
---
src/site/markdown/faq.md | 18 ++++++------------
src/site/markdown/index.md.vm | 20 ++++++++++----------
src/site/xdoc/download.xml.vm | 23 ++++++++++-------------
3 files changed, 26 insertions(+), 35 deletions(-)
diff --git a/src/site/markdown/faq.md b/src/site/markdown/faq.md
index 103ba9c..8ffb074 100644
--- a/src/site/markdown/faq.md
+++ b/src/site/markdown/faq.md
@@ -26,26 +26,22 @@ under the License.
# Frequently Asked Questions
1. [Why do I need to use this plugin?](#question1)
-2. [The generated files have a lot of missing information. Looking at the POMs
from the dependencies, the information isn't there either. What can I
do?](#question2)
+2. [The generated files have missing information. The POMs from dependencies
do not contain this information. What should I do?](#question2)
<a id="question1"></a>
### Why do I need to use this plugin?
-This plugin greatly reduces the pain associated with consistent packaging
concerns across a large set of
-projects, or an entire organization. Any project can specify the use of a
remote resource bundle and have the
-resources incorporated into their packaging. This means that you can create
standard settings in a parent POM
-somewhere in the project hierarchy and have all projects use packaged common
resources in a standard way like
-licenses, other legal notices and disclaimers, or anything else that may be
common.
+This plugin reduces the pain of consistent packaging across many projects. Any
project can specify a remote resource bundle. The resources get incorporated
into their packaging. You can create standard settings in a parent POM and have
all projects use packaged common resources.
<a id="question2"></a>
-### The generated files have a lot of missing information. Looking at the POMs
from the dependencies, the information isn't there either. What can I do?
+### The generated files have missing information. The POMs from dependencies
do not contain this information. What should I do?
-There are two solutions:
+You can do one of these two things:
1. File bugs with the projects that produced those artifacts to get them to
fix them.
-2. Use a supplemental data file. You can create a file that contains the
missing metadata. For example:
+2. Use a supplemental data file. For example:
```xml
<supplementalDataModels>
@@ -69,6 +65,4 @@ There are two solutions:
</supplementalDataModels>
```
- That location of that file can then be configured with the
`supplementalModels` configuration element for
- the `process` goal. The supplemental information is merged with the
information provided from the
- repository.
+ You configure the `supplementalModels` configuration element for the
`process` goal with that location. The supplemental information merges with the
repository data.
diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
index 1a8580b..04e2cf6 100644
--- a/src/site/markdown/index.md.vm
+++ b/src/site/markdown/index.md.vm
@@ -26,33 +26,33 @@ under the License.
# ${project.name}
-This plugin is used to retrieve JARs of resources from remote repositories,
process those resources, and incorporate them into JARs you build with Maven.
+This plugin retrieves JARs of resources from remote repositories, processes
those resources, and incorporates them into JARs you build with Maven.
-A very common use-case is the need to package certain resources in a
consistent way across your organization. For example at Apache, it is required
that every JAR produced contains a copy of the Apache license and a notice file
that references all used software in a given project: see [Apache Resource
Bundles](/apache-resource-bundles/).
+A common use-case is packaging resources consistently across your
organization. At Apache, every JAR must contain a copy of the Apache license
and a notice file that references all used software in a given project: see
[Apache Resource Bundles](/apache-resource-bundles/).
Goals Overview
--------------
-- [remote-resources:bundle](./bundle-mojo.html) creates the resource bundle
manifest required by the remote resource bundle processing. The [manifest
file](./remote-resources.html),
`${esc.d}{basedir}/target/classes/META-INF/maven/remote-resources.xml`, is
created from the contents of the `src/main/resources` directory.
-- [remote-resources:process](./process-mojo.html) retrieves the specified
remote resource bundles, processes them and makes them available to the
`process-resources` phase.
-- [remote-resources:aggregate](./aggregate-mojo.html) retrieves the specified
remote resource bundles, processes them and makes them available to the
`process-resources` phase in aggregate mode.
+- [remote-resources:bundle](./bundle-mojo.html) creates the resource bundle
manifest. The [manifest file](./remote-resources.html),
`${esc.d}{basedir}/target/classes/META-INF/maven/remote-resources.xml`, comes
from `src/main/resources`.
+- [remote-resources:process](./process-mojo.html) retrieves remote resource
bundles, processes them, and makes them available to the process-resources
phase.
+- [remote-resources:aggregate](./aggregate-mojo.html) retrieves remote
resource bundles, processes them in aggregate mode, and makes them available to
the process-resources phase.
Usage
-----
-General instructions on how to use the Remote Resources Plugin can be found on
the [usage page](./usage.html). Some more specific use cases are described in
the examples given below.
+General instructions for using the Remote Resources Plugin are on the [usage
page](./usage.html). Some specific use cases appear in the examples below.
-If you need help using some of the more advanced features of the plugin, check
out the advanced help pages:
+If you need help with advanced features, see the advanced help pages:
- [Patching Bad POMs with Supplemental Models](./supplemental-models.html)
-In case you still have questions regarding the plugin's usage, please have a
look at the [FAQ](./faq.html) and feel free to contact the [user mailing
list](./mailing-lists.html). The posts to the mailing list are archived and
could already contain the answer to your question as part of an older thread.
Hence, it is also worth browsing/searching the [mail
archive](./mailing-lists.html).
+If you have questions about the plugin, check the [FAQ](./faq.html) or contact
the [user mailing list](./mailing-lists.html). Posts to the mailing list are
archived. You can browse or search the [mail archive](./mailing-lists.html).
-If you feel like the plugin is missing a feature or has a defect, you can fill
a feature request or bug report in our [issue
tracker](./issue-management.html). When creating a new issue, please provide a
comprehensive description of your concern. Especially for fixing bugs it is
crucial that the developers can reproduce your problem. For this reason, entire
debug logs, POMs or most preferably little demo projects attached to the issue
are very much appreciated. Of course, patches are wel [...]
+If you think the plugin is missing a feature or has a defect, file a feature
request or bug report. When creating an issue, provide a clear description of
your concern. For fixing bugs, attach entire debug logs, POMs, or demo
projects. We also welcome patches. Contributors can get code from our [source
repository](./scm.html) and find more information in the [guide to helping with
Maven](/guides/development/guide-helping.html).
Examples
--------
-To provide you with better understanding of some usages of the Remote
Resources Plugin, you can take a look at the following examples:
+To help you understand the Remote Resources Plugin usages, see these examples:
- [Sharing Resources Example](./examples/sharing-resources.html)
diff --git a/src/site/xdoc/download.xml.vm b/src/site/xdoc/download.xml.vm
index 8f28f05..1920930 100644
--- a/src/site/xdoc/download.xml.vm
+++ b/src/site/xdoc/download.xml.vm
@@ -27,17 +27,17 @@ under the License.
<body>
<section name="Download ${project.name} ${project.version} Source">
- <p><strong>${project.name} ${project.version}</strong> is distributed in
source format.</p>
+ <p><strong>${project.name} ${project.version}</strong> distributes
source code.</p>
- <p>Use a source archive if you intend to build
<strong>${project.name}</strong> yourself.</p>
+ <p>Use a source archive if you want to build ${project.name}
yourself.</p>
- <p>Otherwise, simply use the ready-made binary artifacts from
<strong>central repository</strong>.</p>
+ <p>Otherwise, use the ready-made binary artifacts from the central
repository.</p>
- <p><strong>${project.name}</strong> is distributed under the <a
href="https://www.apache.org/licenses/";>Apache License, version 2.0</a>.</p>
+ <p><strong>${project.name}</strong> uses the Apache License, version
2.0.</p>
<subsection name="Files">
-
- <p>This is the current stable version of
<strong>${project.name}</strong>.</p>
+
+ <p>This is the current stable version of ${project.name}.</p>
<table>
<thead>
@@ -58,18 +58,15 @@ under the License.
</tbody>
</table>
- <p>It is essential that you <a
href="https://www.apache.org/info/verification.html";>verify the integrity</a>
of the downloaded file
- using the checksum (.sha512 file)
- or using the signature (.asc file) against the public <a
href="https://downloads.apache.org/maven/KEYS";>KEYS</a> used by the Apache
Maven developers.
- </p>
+ <p>You must verify the integrity of the downloaded file using the
checksum (.sha512 file) or using the signature (.asc file).</p>
+ <p>Use the public KEYS that Apache Maven developers provide to
verify.</p>
</subsection>
<subsection name="Previous Versions">
- <p>It is strongly recommended to use the latest release version of
<strong>${project.name}</strong> to take advantage of the newest features and
bug fixes.</p>
- <p>Older non-recommended releases can be found on our <a
href="https://archive.apache.org/dist/maven/plugins/";>archive site</a>.</p>
+ <p>You must use the latest release version of ${project.name} to get
new features and bug fixes.</p>
+ <p>Older releases exist on the archive site. These releases are not
recommended.</p>
</subsection>
</section>
</body>
</document>
-
