You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/08/06 17:01:45 UTC

(maven-shared-resources) branch master updated (9bef268 -> 8eb2d3b)

This is an automated email from the ASF dual-hosted git repository.

slachiewicz pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/maven-shared-resources.git


    from 9bef268  Update tag template in release-drafter.yml
     new 405f308  Rename the site documents ahead of converting them
     new 8eb2d3b  Port the site documentation from APT to Markdown

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 src/site/apt/index.apt.vm            |  57 ------------------
 src/site/apt/maven_checks.apt.vm     |  36 ------------
 src/site/apt/usage.apt.vm            | 110 -----------------------------------
 src/site/markdown/index.md.vm        |  47 +++++++++++++++
 src/site/markdown/maven_checks.md.vm |  24 ++++++++
 src/site/markdown/usage.md.vm        |  96 ++++++++++++++++++++++++++++++
 6 files changed, 167 insertions(+), 203 deletions(-)
 delete mode 100644 src/site/apt/index.apt.vm
 delete mode 100644 src/site/apt/maven_checks.apt.vm
 delete mode 100644 src/site/apt/usage.apt.vm
 create mode 100644 src/site/markdown/index.md.vm
 create mode 100644 src/site/markdown/maven_checks.md.vm
 create mode 100644 src/site/markdown/usage.md.vm


(maven-shared-resources) 02/02: Port the site documentation from APT to Markdown

Posted by sl...@apache.org.
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-shared-resources.git

commit 8eb2d3b9f2304ac8751331465e72e69f71af7767
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 13:53:02 2026 +0200

    Port the site documentation from APT to Markdown
    
    3 page(s) converted with doxia-converter and then cleaned up by hand:
    
    - <<<code>>> becomes backticks, <<bold>> becomes **bold**, {{{url}text}}
      becomes [text](url)
    - the ASF license header becomes a single block HTML comment
    - a page whose only Velocity reference was ${project.name} is now a plain
      .md with the title spelled out
    - a page that keeps a reference stays a .vm. Velocity reads ## as a line
      comment and would silently swallow every ATX heading below level one, so
      subsections use setext underlines and anything deeper is wrapped in
      #[[ ... ]]#
    - references APT rendered literally are escaped, so they do not resolve
    
    Verified by building the site before and after and comparing every
    generated page: the visible text and the link targets are unchanged apart
    from <b>/<i> becoming <strong>/<em> and quotes in prose picking up the
    Markdown module's typographic substitution.
---
 src/site/markdown/index.md.vm        | 76 +++++++++++++++-------------------
 src/site/markdown/maven_checks.md.vm | 50 +++++++++-------------
 src/site/markdown/usage.md.vm        | 80 +++++++++++++++---------------------
 3 files changed, 85 insertions(+), 121 deletions(-)

diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
index be96b86..1476f30 100644
--- a/src/site/markdown/index.md.vm
+++ b/src/site/markdown/index.md.vm
@@ -1,57 +1,47 @@
- ------
- Introduction
- ------
- Dennis Lundberg
- ------
- 2015-01-22
- ------
+<!--
+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
 
-~~ 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.
+http://www.apache.org/licenses/LICENSE-2.0
 
-${project.name}
+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.
+-->
 
-  This is a collection of templates that are specific to the Maven project. They
-  are probably not of interest to projects other than Apache Maven.
+# ${project.name}
 
-  Below you will find a listing of the resources that can be found in the
-  current version (${project.version}) of Maven Shared Resources. They are
-  listed by which plugin they are meant to be used with.
+This is a collection of templates that are specific to the Maven project. They are probably not of interest to projects other than Apache Maven.
 
-* Maven Checkstyle Plugin
+Below you will find a listing of the resources that can be found in the current version (${project.version}) of Maven Shared Resources. They are listed by which plugin they are meant to be used with.
 
-** <<<config/maven-header.txt>>>
+Maven Checkstyle Plugin
+-----------------------
 
-  This is a license header template that can be used by Maven Checkstyle Plugin
-  to verify that all files are using this license header.
+#[[### `config/maven-header.txt`]]#
 
-** {{{./maven_checks.html}<<<config/maven_checks.xml>>>}}
+This is a license header template that can be used by Maven Checkstyle Plugin to verify that all files are using this license header.
 
-  This is a Checkstyle configuration file for
-  {{{/developers/conventions/code.html}Maven coding conventions}} that can be
-  used in Maven Checkstyle Plugin.
+#[[### [`config/maven_checks.xml`](./maven_checks.html)]]#
 
-* IntelliJ IDEA code formater
+This is a Checkstyle configuration file for [Maven coding conventions](/developers/conventions/code.html) that can be used in Maven Checkstyle Plugin.
 
-** <<<config/maven-idea-codestyle-2022.xml>>>
+IntelliJ IDEA code formater
+---------------------------
 
-  This is IntelliJ IDEA code formater which can be imported into IDE.
+#[[### `config/maven-idea-codestyle-2022.xml`]]#
 
-* Usage
+This is IntelliJ IDEA code formater which can be imported into IDE.
 
-  General instructions on how to use the Maven Shared Resources can be found on
-  the {{{./usage.html}usage page}}.
+Usage
+-----
+
+General instructions on how to use the Maven Shared Resources can be found on the [usage page](./usage.html).
diff --git a/src/site/markdown/maven_checks.md.vm b/src/site/markdown/maven_checks.md.vm
index 098a95e..d2ab2d0 100644
--- a/src/site/markdown/maven_checks.md.vm
+++ b/src/site/markdown/maven_checks.md.vm
@@ -1,36 +1,24 @@
- ------
- config/maven_checks.xml
- ------
- Hervé Boutemy
- ------
- 2015-01-18
- ------
+<!--
+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
 
-~~ 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.
+http://www.apache.org/licenses/LICENSE-2.0
 
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
+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.
+-->
 
+# `config/maven_checks.xml`
 
-<<<config/maven_checks.xml>>>
+This is a predefined ruleset for [Maven coding conventions](/developers/conventions/code.html) that can be used in Maven Checkstyle Plugin:
 
-  This is a predefined ruleset for
- {{{/developers/conventions/code.html}Maven coding conventions}} that can be
-  used in Maven Checkstyle Plugin:
-
-%{snippet|file=${project.basedir}/src/main/resources/config/maven_checks.xml}
+<!-- MACRO{snippet|file=${project.basedir}/src/main/resources/config/maven_checks.xml} -->
diff --git a/src/site/markdown/usage.md.vm b/src/site/markdown/usage.md.vm
index 250b4bd..20e014d 100644
--- a/src/site/markdown/usage.md.vm
+++ b/src/site/markdown/usage.md.vm
@@ -1,43 +1,32 @@
- ------
- Usage
- ------
- Dennis Lundberg
- ------
- 2011-05-01
- ------
+<!--
+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
 
-~~ 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.
+http://www.apache.org/licenses/LICENSE-2.0
 
-Usage
+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.
+-->
 
-  There are a couple of things you need to do to use Maven Shared Resources. First
-  you need to give the plugin that will use the resources access to them. After
-  that you configure the plugin to actually use the resources.
+# Usage
 
+There are a couple of things you need to do to use Maven Shared Resources. First you need to give the plugin that will use the resources access to them. After that you configure the plugin to actually use the resources.
 
-* Add the resources to the plugin
+Add the resources to the plugin
+-------------------------------
 
-  First you add maven-shared-resources as a dependency to a plugin in your
-  <<<pom.xml>>>. This is done to give the plugin access to the resources within
-  the maven-shared-resources JAR file. In this example we will use the resources
-  in Maven Checkstyle Plugin.
+First you add maven-shared-resources as a dependency to a plugin in your `pom.xml`. This is done to give the plugin access to the resources within the maven-shared-resources JAR file. In this example we will use the resources in Maven Checkstyle Plugin.
 
-+----------+
+```xml
 <project>
   ...
   <build>
@@ -64,15 +53,14 @@ Usage
   </build>
   ...
 </project>
-+----------+
+```
 
+Configure the plugin to use the resources
+-----------------------------------------
 
-* Configure the plugin to use the resources
+Now you can use the resources in the plugin. You can use them as if they existed in your own project, like this:
 
-  Now you can use the resources in the plugin. You can use them as if they
-  existed in your own project, like this:
-
-+----------+
+```xml
 <project>
   ...
   <build>
@@ -96,15 +84,13 @@ Usage
   </build>
   ...
 </project>
-+----------+
-
+```
 
-* Execute the plugin
+Execute the plugin
+------------------
 
-  All is now set up to make use of the resources in the plugin for your project.
-  Execute the plugin like you would normally do, to see the resources put to
-  practical use.
+All is now set up to make use of the resources in the plugin for your project. Execute the plugin like you would normally do, to see the resources put to practical use.
 
-+----------+
+```shell
 mvn checkstyle:check
-+----------+
+```


(maven-shared-resources) 01/02: Rename the site documents ahead of converting them

Posted by sl...@apache.org.
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-shared-resources.git

commit 405f308aff5d71fd9d83c85a2993cb333942ea1a
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 13:53:02 2026 +0200

    Rename the site documents ahead of converting them
    
    A pure rename, so that git records it and `git log --follow` and `git blame` still
    reach the history of each page after the conversion that follows. The content is
    still APT at this point and the site does not build between the two commits.
---
 src/site/{apt/index.apt.vm => markdown/index.md.vm}               | 0
 src/site/{apt/maven_checks.apt.vm => markdown/maven_checks.md.vm} | 0
 src/site/{apt/usage.apt.vm => markdown/usage.md.vm}               | 0
 3 files changed, 0 insertions(+), 0 deletions(-)

diff --git a/src/site/apt/index.apt.vm b/src/site/markdown/index.md.vm
similarity index 100%
rename from src/site/apt/index.apt.vm
rename to src/site/markdown/index.md.vm
diff --git a/src/site/apt/maven_checks.apt.vm b/src/site/markdown/maven_checks.md.vm
similarity index 100%
rename from src/site/apt/maven_checks.apt.vm
rename to src/site/markdown/maven_checks.md.vm
diff --git a/src/site/apt/usage.apt.vm b/src/site/markdown/usage.md.vm
similarity index 100%
rename from src/site/apt/usage.apt.vm
rename to src/site/markdown/usage.md.vm