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/10 01:19:10 UTC
(maven-archetypes) 02/02: Convert the demo archetypes' pages to Markdown
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch archetype-demos-markdown
in repository https://gitbox.apache.org/repos/asf/maven-archetypes.git
commit 6fb0517cd826f9b2f648f2a50c6fd4621a4cb517
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Mon Aug 10 03:18:58 2026 +0200
Convert the demo archetypes' pages to Markdown
Both archetypes handed a generated project an APT src/site while shipping
Markdown examples beside it, so a new project started life with two
documentation formats and no reason to prefer either.
All four pages are content rather than format demonstration, so all four
are converted and none deleted. That is the difference from the site
archetype, where format.apt existed only to show what APT looks like and
has no Markdown equivalent worth writing.
Neither site descriptor needs a change: conversion does not rename a
generated page, so every href in both menus still resolves exactly as
before. Their entries for faq.html, plugin-info.html and the report pages
are template placeholders for the user to fill in and are untouched.
The reference fixture under site-simple's src/test/resources is the
expected generated output, so it carries the converted page too - it is
a copy of what the archetype now produces, and the integration test
compares the two.
Verified by running both archetypes' ITs, which generate a project and
build its site, before and after: both pass, the same pages are produced,
and every one is identical in text, metadata, structural tags and anchor
ids. The lone diff is an absolute path in distribution-management, which
differs because the two builds ran in different directories.
Generated-by: Claude Opus 5 (1M context)
---
.../src/site/markdown/examples/example.md | 22 +++++-----
.../archetype-resources/src/site/markdown/index.md | 49 ++++++++--------------
.../archetype-resources/src/site/markdown/usage.md | 26 ++++++------
.../archetype-resources/src/site/markdown/index.md | 25 +++++------
.../it-basic/reference/src/site/markdown/index.md | 25 +++++------
5 files changed, 61 insertions(+), 86 deletions(-)
diff --git a/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/examples/example.md b/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/examples/example.md
index 08c35af..3ac7a8f 100644
--- a/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/examples/example.md
+++ b/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/examples/example.md
@@ -1,17 +1,15 @@
- ------
- SMTP Authentication
- ------
- Allan Ramirez
- ------
- 2005-10-16
- ------
+---
+title: SMTP Authentication
+author:
+ - Allan Ramirez
+date: 2005-10-16
+---
-SMTP Authentication
+# SMTP Authentication
- If the SMTP host needs authentication, you can provide your username and password
- in the <<<\<configuration\>>>> section:
+If the SMTP host needs authentication, you can provide your username and password in the `<configuration>` section:
--------------------
+```
<project>
...
<build>
@@ -31,4 +29,4 @@ SMTP Authentication
</build>
...
</project>
--------------------
+```
diff --git a/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/index.md b/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/index.md
index feb4f6c..86a5b0f 100644
--- a/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/index.md
+++ b/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/index.md
@@ -1,43 +1,28 @@
- ------
- Introduction
- ------
- Jason van Zyl
- ------
- 2010-04-26
- ------
+---
+title: Introduction
+author:
+ - Jason van Zyl
+date: 2010-04-26
+---
-Maven 2 SuperDuper Plugin
+# Maven 2 SuperDuper Plugin
- This plugin is used to transform your development life. Don't bother with self-help
- books on how to get over your build-time blues. Just use this plugin and
- everything will miraculously change.
+This plugin is used to transform your development life. Don't bother with self-help books on how to get over your build-time blues. Just use this plugin and everything will miraculously change.
-* Goals Overview
+## Goals Overview
- * {{{./superduper-transform.html}superduper:transform}} performs the miraculous build transformation.
+- [superduper:transform](./superduper-transform.html) performs the miraculous build transformation.
- []
+## Usage
-* Usage
+General instructions on how to use the SuperDuper Plugin can be found on the [usage page](./usage.html). Some more specific use cases are described in the examples given below.
- General instructions on how to use the SuperDuper 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](./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).
- 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 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 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}}.
+## Examples
-* Examples
+To provide you with better understanding of some usages of the SuperDuper Plugin, you can take a look at the following examples:
- To provide you with better understanding of some usages of the SuperDuper Plugin,
- you can take a look at the following examples:
-
- * {{{./examples/sample-example.html}Sample Example}}
+- [Sample Example](./examples/sample-example.html)
diff --git a/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/usage.md b/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/usage.md
index 4e6b431..62ed07e 100644
--- a/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/usage.md
+++ b/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/usage.md
@@ -1,21 +1,19 @@
- ------
- Usage
- ------
- Jason van Zyl
- ------
- 2010-04-26
- ------
+---
+title: Usage
+author:
+ - Jason van Zyl
+date: 2010-04-26
+---
-Usage
+# Usage
- This plugin is used to create miraculously transform your build!
+This plugin is used to create miraculously transform your build!
-*How to miraculously transform your build
+## How to miraculously transform your build
- Describe here how you miraculously transform peoples' builds!
+Describe here how you miraculously transform peoples' builds!
--------------------
+```
Put your awesome example here.
-
--------------------
\ No newline at end of file
+```
diff --git a/maven-archetype-site-simple/src/main/resources/archetype-resources/src/site/markdown/index.md b/maven-archetype-site-simple/src/main/resources/archetype-resources/src/site/markdown/index.md
index cf4c309..e5726c0 100644
--- a/maven-archetype-site-simple/src/main/resources/archetype-resources/src/site/markdown/index.md
+++ b/maven-archetype-site-simple/src/main/resources/archetype-resources/src/site/markdown/index.md
@@ -1,18 +1,15 @@
- -----
- Title Here
- -----
- Author Here
- -----
- Date Here (AAAA-MM-DD)
- -----
+---
+title: Title Here
+author:
+ - Author Here
+date: Date Here (AAAA-MM-DD)
+---
-Maven Site for your project
+# Maven Site for your project
- Congratulations! If you are looking at this page then you have successfully generated a
- template site employing the simple site archetype and you have run:
-
-+-----+
+Congratulations! If you are looking at this page then you have successfully generated a template site employing the simple site archetype and you have run:
-mvn site
+```bash
-+-----+
+mvn site
+```
diff --git a/maven-archetype-site-simple/src/test/resources/projects/it-basic/reference/src/site/markdown/index.md b/maven-archetype-site-simple/src/test/resources/projects/it-basic/reference/src/site/markdown/index.md
index cf4c309..e5726c0 100644
--- a/maven-archetype-site-simple/src/test/resources/projects/it-basic/reference/src/site/markdown/index.md
+++ b/maven-archetype-site-simple/src/test/resources/projects/it-basic/reference/src/site/markdown/index.md
@@ -1,18 +1,15 @@
- -----
- Title Here
- -----
- Author Here
- -----
- Date Here (AAAA-MM-DD)
- -----
+---
+title: Title Here
+author:
+ - Author Here
+date: Date Here (AAAA-MM-DD)
+---
-Maven Site for your project
+# Maven Site for your project
- Congratulations! If you are looking at this page then you have successfully generated a
- template site employing the simple site archetype and you have run:
-
-+-----+
+Congratulations! If you are looking at this page then you have successfully generated a template site employing the simple site archetype and you have run:
-mvn site
+```bash
-+-----+
+mvn site
+```