This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-resources-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 1fe3ff8 Link to the filtering resources guide on maven.apache.org
1fe3ff8 is described below
commit 1fe3ff8f871886f0349b0c8658d2ab3b11dde0eb
Author: Sylwester Lachiewicz <[email protected]>
AuthorDate: Sat Oct 31 20:05:30 2026 +0000
Link to the filtering resources guide on maven.apache.org
---
src/site/markdown/examples/encoding.md.vm | 69 ---------
src/site/markdown/examples/escape-filtering.md.vm | 55 -------
src/site/markdown/examples/filter.md | 181 ----------------------
src/site/markdown/index.md | 5 +-
src/site/site.xml | 8 +-
5 files changed, 3 insertions(+), 315 deletions(-)
diff --git a/src/site/markdown/examples/encoding.md.vm
b/src/site/markdown/examples/encoding.md.vm
deleted file mode 100644
index 2762895..0000000
--- a/src/site/markdown/examples/encoding.md.vm
+++ /dev/null
@@ -1,69 +0,0 @@
----
-title: Specifying a character encoding scheme
-author:
- - Franz Allan See
- - Karl Heinz Marbaise
-date: 2016-05-13
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-
-# Specifying a character encoding scheme
-
-A character encoding scheme such as `ASCII`, `UTF-8` or `UTF-16` can be chosen
to be used for the reading and writing of files.
-
-The best practice is to [define
encoding](https://maven.apache.org/general.html#encoding-warning) for copying
filtered resources via the property `${esc.d}{project.build.sourceEncoding}`
which should be defined in the pom properties section like this:
-
-```xml
-<project ...>
- ...
- <properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- ...
- </properties>
- ..
-</project>
-```
-
-By using the above property `maven-resources-plugin` will automatically use
this [encoding](../resources-mojo.html#encoding).
-
-Occasionally you need to change the encoding explicitly for different
purposes. This can be done by defining the encoding via the configuration like
this:
-
-```xml
-<project>
- ...
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-resources-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- ...
- <encoding>UTF-8</encoding>
- ...
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
-</project>
-```
diff --git a/src/site/markdown/examples/escape-filtering.md.vm
b/src/site/markdown/examples/escape-filtering.md.vm
deleted file mode 100644
index 9d5f0c6..0000000
--- a/src/site/markdown/examples/escape-filtering.md.vm
+++ /dev/null
@@ -1,55 +0,0 @@
----
-title: Escape Filtering
-author:
- - Olivier Lamy
-date: 2008-09-05
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-
-# Escape filtering
-
-You can escape filtering with configurable String.
-
-This means expression ${esc.d}{ } and @ @ preceded will replace by the
expression : ${esc.b}${esc.b}${esc.d}{java.home} -> ${esc.d}{java.home}.
-
-**The escapeString will be removed**
-
-```xml
-<project>
- ...
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-resources-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- ...
- <escapeString>\</escapeString>
- ...
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
-</project>
-```
diff --git a/src/site/markdown/examples/filter.md
b/src/site/markdown/examples/filter.md
deleted file mode 100644
index 9b23d14..0000000
--- a/src/site/markdown/examples/filter.md
+++ /dev/null
@@ -1,181 +0,0 @@
----
-title: Filtering
-author:
- - Franz Allan See
-date: 2008-09-05
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-
-# Filtering
-
-Variables can be included in your resources. These variables, denoted by the
`${...}` or `@...@` delimiters, can come from the system properties, your
project properties, from your filter resources and from the command line.
-
-For example, if we have a resource `src/main/resources/hello.txt` containing
-
-```unknown
-Hello ${name}
-```
-
-And a POM like this
-
-```xml
-<project>
- ...
- <name>My Resources Plugin Practice Project</name>
- ...
- <build>
- ...
- <resources>
- <resource>
- <directory>src/main/resources</directory>
- </resource>
- ...
- </resources>
- ...
- </build>
- ...
-</project>
-```
-
-Upon calling
-
-```shell
-mvn resources:resources
-```
-
-This will create a resource output in `target/classes/hello.txt` which
contains exactly the same text.
-
-```unknown
-Hello ${name}
-```
-
-However, if we add a `<filtering>` element to our POM and set it to `true`
like this:
-
-```xml
-<project>
- ...
- <resource>
- <directory>src/main/resources</directory>
- <filtering>true</filtering>
- </resource>
- ...
-</project>
-```
-
-Our `target/classes/hello.txt` after calling
-
-```shell
-mvn resources:resources
-```
-
-would be
-
-```unknown
-Hello My Resources Plugin Practice Project
-```
-
-That's because the name variable was replaced by the value of the project's
name (which was specified in the POM).
-
-Moreover, we can also assign values through the command line using the "-D"
option. For example, to change the value for the variable `name` to "world", we
can simply invoke this command:
-
-```shell
-mvn resources:resources -Dname="world"
-```
-
-And the output in `target/classes/hello.txt` would be
-
-```unknown
-Hello world
-```
-
-Furthermore, we are not limited to use pre-defined project variables. We can
specify our own variables and their values in the `<properties>` element. For
example, if we want to change the variable from "name" to "your.name", we can
do so by adding a `<your.name>` element within the `<properties>` element.
-
-```xml
-<project>
- ...
- <properties>
- <your.name>world</your.name>
- </properties>
- ...
-</project>
-```
-
-But to organize your project, you may want to put all your variables and their
values in a separate file so that you will not have to rewrite your POM, or set
their values all the time with every build. This can be done by adding a filter.
-
-```xml
-<project>
- ...
- <name>My Resources Plugin Practice Project</name>
- ...
- <build>
- ...
- <filters>
- <filter>[a filter property]</filter>
- </filters>
- ...
- </build>
- ...
-</project>
-```
-
-For example, we can separate "your.name" from the POM by specifying a filter
file `my-filter-values.properties` containing:
-
-```properties
-your.name = world
-```
-
-and adding that to our POM
-
-```xml
-<project>
- ...
- <filters>
- <filter>my-filter-values.properties</filter>
- </filters>
- ...
-</project>
-```
-
-**Warning:** Do not filter files with binary content like images! This will
most likely result in corrupt output.
-
-If you have both text files and binary files as resources it is recommended to
have two separated folders. One folder `src/main/resources` (default) for the
resources which are not filtered and another folder
`src/main/resources-filtered` for the resources which are filtered.
-
-```xml
-<project>
- ...
- <build>
- ...
- <resources>
- <resource>
- <directory>src/main/resources-filtered</directory>
- <filtering>true</filtering>
- </resource>
- ...
- </resources>
- ...
- </build>
- ...
-</project>
-```
-
-Now you can put those files into `src/main/resources` which should not
filtered and the other files into `src/main/resources-filtered`.
-
-As already mentioned filtering binary files like images,pdf\`s etc. could
result in corrupted output. To prevent such problems you can [configure file
extensions](./binaries-filtering.html) which will not being filtered.
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 11cc4ea..760a87b 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -57,13 +57,10 @@ If you feel like the plugin is missing a feature or has a
defect, you can fill a
## Examples
-The following examples show how to use the Resources Plugin in more advanced
use cases:
+The [guide to filtering
resources](https://maven.apache.org/guides/mini/guide-filtering-resources.html)
covers variables, filter files, escaping and encoding. The following examples
show how to use the Resources Plugin in more advanced use cases:
-- [Specifying a character encoding scheme](./examples/encoding.html)
- [Specifying resource directories](./examples/resource-directory.html)
-- [Filtering](./examples/filter.html)
- [Including and excluding files and
directories](./examples/include-exclude.html)
-- [Escape filtering](./examples/escape-filtering.html)
- [Copy resources](./examples/copy-resources.html)
- [Binaries filtering](./examples/binaries-filtering.html)
- [Custom resources filters](./examples/custom-resource-filters.html)
diff --git a/src/site/site.xml b/src/site/site.xml
index bc1ce6f..65de68d 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -32,18 +32,14 @@ under the License.
<item name="Download" href="download.html"/>
</menu>
<menu name="Examples">
- <item name="Specifying a character encoding scheme"
- href="/examples/encoding.html"/>
+ <item name="Filtering resources (guide)"
+
href="https://maven.apache.org/guides/mini/guide-filtering-resources.html"/>
<item name="Specifying resource directories"
href="/examples/resource-directory.html"/>
- <item name="Filtering"
- href="/examples/filter.html"/>
<item name="Filtering properties files"
href="/examples/filtering-properties-files.html"/>
<item name="Including and excluding files and directories"
href="/examples/include-exclude.html"/>
- <item name="Escape Filtering"
- href="/examples/escape-filtering.html"/>
<item name="Copy Resources"
href="/examples/copy-resources.html"/>
<item name="Binaries Filtering"