From 5b45092b1ed664264c0bd6a971646790f88be14f Mon Sep 17 00:00:00 2001 From: Sylwester Lachiewicz Date: Fri, 7 Aug 2026 23:20:55 +0200 Subject: [PATCH 1/2] Rename the site documents ahead of converting them Kept as its own commit so that git log --follow and git blame still reach each page's history once the content changes. --- .../examples/configureplugin.md.vm} | 0 src/site/{apt/index.apt.vm => markdown/index.md.vm} | 0 src/site/{apt/usage.apt.vm => markdown/usage.md.vm} | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename src/site/{apt/examples/configureplugin.apt.vm => markdown/examples/configureplugin.md.vm} (100%) rename src/site/{apt/index.apt.vm => markdown/index.md.vm} (100%) rename src/site/{apt/usage.apt.vm => markdown/usage.md.vm} (100%) diff --git a/src/site/apt/examples/configureplugin.apt.vm b/src/site/markdown/examples/configureplugin.md.vm similarity index 100% rename from src/site/apt/examples/configureplugin.apt.vm rename to src/site/markdown/examples/configureplugin.md.vm 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/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 From 6e2348a2454cd6e2100e6bab3b87ac27ee2df639 Mon Sep 17 00:00:00 2001 From: Sylwester Lachiewicz Date: Fri, 7 Aug 2026 23:21:43 +0200 Subject: [PATCH 2/2] Port the site documentation from APT to Markdown The maintenance line still carried its site documentation in APT, so a release from it would have published the old pages while the default branch serves Markdown. Velocity reads ## as a line comment, so in a page that keeps its .vm suffix the level two headings use a setext underline and deeper ones are wrapped in an unparsed block. Where APT wrote $\{foo\} for a reference it means to display, the parser strips the backslashes, so those are now ${esc.d}{foo}. Verified by building the site before and after and comparing all 19 generated pages: every one is identical in its title, author and date metadata, its visible text and every link target. --- .../markdown/examples/configureplugin.md.vm | 72 ++++++------ src/site/markdown/index.md.vm | 110 +++++++----------- src/site/markdown/usage.md.vm | 104 ++++++++--------- 3 files changed, 126 insertions(+), 160 deletions(-) diff --git a/src/site/markdown/examples/configureplugin.md.vm b/src/site/markdown/examples/configureplugin.md.vm index 4b11cb8..c0b063c 100644 --- a/src/site/markdown/examples/configureplugin.md.vm +++ b/src/site/markdown/examples/configureplugin.md.vm @@ -1,36 +1,34 @@ - ------ - Configuring Source Plugin - ------ - Maria Odea Ching - ------ - 11 July 2006 - ------ - -~~ 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. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Configuring Source Plugin - - To customize the plugin, you can change its configuration parameters in your POM, as shown below: - -+-----+ +--- +title: Configuring Source Plugin +author: + - Maria Odea Ching +date: 11 July 2006 +--- + + + +# Configuring Source Plugin + +To customize the plugin, you can change its configuration parameters in your POM, as shown below: + +```unknown ... @@ -49,9 +47,7 @@ Configuring Source Plugin ... -+-----+ +``` + +The generated jar file will be named by the value of the `finalName` plus "-sources" if it is the main sources. Otherwise, it would be `finalName` plus "-test-sources" if it is the test sources. It will be generated in the specified `outputDirectory`. The `attach` parameter specifies whether the java sources will be attached to the artifact list of the project. - The generated jar file will be named by the value of the <<>> plus "-sources" if it is the main sources. Otherwise, - it would be <<>> plus "-test-sources" if it is the test sources. It will be generated in the specified - <<>>. The <<>> parameter specifies whether the java sources will be attached to the artifact list of - the project. diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm index 4313308..dcf495c 100644 --- a/src/site/markdown/index.md.vm +++ b/src/site/markdown/index.md.vm @@ -1,83 +1,61 @@ - ------ - Introduction - ------ - Maria Odea Ching - ------ - 2013-07-22 - ------ +--- +title: Introduction +author: + - Maria Odea Ching +date: 2013-07-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 - ~~ - ~~ 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. + - The Source Plugin creates a jar archive of the source files of the current project. The jar file is, by default, - created in the project's target directory. +# ${project.name} -* Important Hint +The Source Plugin creates a jar archive of the source files of the current project. The jar file is, by default, created in the project's target directory. - Starting with version 3.0.0 of the plugin all properties which could be used via command line - have been named based on the following schema <>. Further details can be found - in the goal documentations. +Important Hint +-------------- -* Goals Overview +Starting with version 3.0.0 of the plugin all properties which could be used via command line have been named based on the following schema **maven.source.\***. Further details can be found in the goal documentations. - The Source Plugin has five goals: +Goals Overview +-------------- - * {{{./aggregate-mojo.html}source:aggregate}} aggregrates sources for all modules in an aggregator project. +The Source Plugin has five goals: - * {{{./jar-mojo.html}source:jar}} is used to bundle the main sources of the project into a jar archive. +- [source:aggregate](./aggregate-mojo.html) aggregrates sources for all modules in an aggregator project. +- [source:jar](./jar-mojo.html) is used to bundle the main sources of the project into a jar archive. +- [source:test-jar](./test-jar-mojo.html) on the other hand, is used to bundle the test sources of the project into a jar archive. +- [source:jar-no-fork](./jar-no-fork-mojo.html) is similar to **jar** but does not fork the build lifecycle. +- [source:test-jar-no-fork](./test-jar-no-fork-mojo.html) is similar to **test-jar** but does not fork the build lifecycle. - * {{{./test-jar-mojo.html}source:test-jar}} on the other hand, is used to bundle the test sources of the project into a - jar archive. +Usage +----- - * {{{./jar-no-fork-mojo.html}source:jar-no-fork}} is similar to <> but does not fork the build lifecycle. +General instructions on how to use the Source Plugin can be found on the [usage page](./usage.html). Some more specific use cases are described in the examples given below. - * {{{./test-jar-no-fork-mojo.html}source:test-jar-no-fork}} is similar to <> but does not fork the build lifecycle. +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 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 welcome, too. Contributors can check out the project from our [source repository](./scm.html) and will find supplementary information in the [guide to helping with Maven](http://maven.apache.org/guides/development/guide-helping.html). -* Usage +Examples +-------- - General instructions on how to use the Source Plugin can be found on the {{{./usage.html}usage page}}. Some more - specific use cases are described in the examples given below. - - In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel - free to contact the {{{./mailing-lists.html}user mailing list}}. 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 {{{./mailing-lists.html}mail archive}}. - - 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-management.html}issue tracker}}. 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 welcome, too. Contributors can check out the project from our - {{{./scm.html}source repository}} and will find supplementary information in the - {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}. - -* Examples - - To provide you with better understanding on some usages of the Source plugin, you can take a look into the - following examples: - - * {{{./examples/configureplugin.html}Configuring Source Plugin}} - - [] +To provide you with better understanding on some usages of the Source plugin, you can take a look into the following examples: +- [Configuring Source Plugin](./examples/configureplugin.html) diff --git a/src/site/markdown/usage.md.vm b/src/site/markdown/usage.md.vm index 5976816..e70801b 100644 --- a/src/site/markdown/usage.md.vm +++ b/src/site/markdown/usage.md.vm @@ -1,59 +1,53 @@ - ------ - Usage - ------ - Maria Odea Ching - ------ - 11 July 2006 - ------ - -~~ 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. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Usage - - The source plugin can be used to create a jar file of the project sources from the command line or by binding - the goal to the project's build lifecycle. To generate the jar from the command line, use the following command: - -+-----+ +--- +title: Usage +author: + - Maria Odea Ching +date: 11 July 2006 +--- + + + +# Usage + +The source plugin can be used to create a jar file of the project sources from the command line or by binding the goal to the project's build lifecycle. To generate the jar from the command line, use the following command: + +```unknown mvn source:jar -+-----+ +``` - A jar file of the test sources can also be generated by executing: +A jar file of the test sources can also be generated by executing: -+-----+ +```unknown mvn source:test-jar -+-----+ +``` -*Installing the sources along with your artifact +Installing the sources along with your artifact +----------------------------------------------- - There are two ways to do this. You can either bind this plugin to a phase or - you can add it to a profile. The goals {{{./jar-no-fork-mojo.html}source:jar-no-fork}} and - {{{./test-jar-no-fork-mojo.html}source:test-jar-no-fork}} are preferred for binding - the goal to the build lifecycle. +There are two ways to do this. You can either bind this plugin to a phase or you can add it to a profile. The goals [source:jar-no-fork](./jar-no-fork-mojo.html) and [source:test-jar-no-fork](./test-jar-no-fork-mojo.html) are preferred for binding the goal to the build lifecycle. -**Installing the sources using a phase binding +#[[### Installing the sources using a phase binding]]# - Here is how you would configure the plugin in your <<>> to run - automatically during the phase: +Here is how you would configure the plugin in your `pom.xml` to run automatically during the _verify_ phase: -+-----+ +```unknown ... @@ -76,18 +70,15 @@ mvn source:test-jar ... -+-----+ +``` - We are using the phase here because it is the phase that comes - before the phase, thus making sure that the sources jar has been - created <> the install takes place. +We are using the _verify_ phase here because it is the phase that comes before the _install_ phase, thus making sure that the sources jar has been created **before** the install takes place. -**Installing the sources using a profile +#[[### Installing the sources using a profile]]# - If you want to install a jar of your sources along with your artifact during - the release process, you can add this to your <<>> file: +If you want to install a jar of your sources along with your artifact during the release process, you can add this to your `pom.xml` file: -+-----+ +```unknown ... @@ -114,4 +105,5 @@ mvn source:test-jar ... -+-----+ +``` +