From b4448b007dada3c50a8d6cf6b68bc3830b582764 Mon Sep 17 00:00:00 2001 From: Sylwester Lachiewicz Date: Sat, 8 Aug 2026 20:41:41 +0200 Subject: [PATCH 1/2] Rename the FAQ ahead of converting it Git records a rename plus a rewrite in one commit as a delete and an add, which stops 'git log --follow'. Splitting the rename out keeps the history. Please merge or rebase rather than squash. --- modello-maven-plugin/src/site/{fml/faq.fml => markdown/faq.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename modello-maven-plugin/src/site/{fml/faq.fml => markdown/faq.md} (100%) diff --git a/modello-maven-plugin/src/site/fml/faq.fml b/modello-maven-plugin/src/site/markdown/faq.md similarity index 100% rename from modello-maven-plugin/src/site/fml/faq.fml rename to modello-maven-plugin/src/site/markdown/faq.md From 9d6be61295dd8cb5a829dee4bbfd7abee671ed71 Mon Sep 17 00:00:00 2001 From: Sylwester Lachiewicz Date: Sat, 8 Aug 2026 20:42:52 +0200 Subject: [PATCH 2/2] Convert the FAQ from FML to Markdown and fix its dead links doxia-converter's FML output was not usable: the questions came out as link-reference syntax rather than headings, the [top] back-links became links to a nonexistent 'top' page, the contents links lost their # anchors, and '=' was escaped inside query strings. The page is written out by hand instead. Explicit anchors keep the existing deep links working: #question1 and #question2 still resolve. All four svn.apache.org viewvc links were dead - they return 401 since Apache retired public viewvc - and now point at the models on GitHub. maven.mdo gained a note distinguishing the Maven 4 and Maven 3.9.x versions. The assembly plugin's descriptor.mdo and component.mdo are now assembly.mdo and assembly-component.mdo, and Doxia's decoration model is now the site model. The four live links moved from http to https. FML generates a [top] back-link after each answer; those are dropped rather than hand-written, which is the only rendering loss. Part of codehaus-plexus/.github#58 --- modello-maven-plugin/src/site/markdown/faq.md | 66 ++++++++++--------- 1 file changed, 35 insertions(+), 31 deletions(-) diff --git a/modello-maven-plugin/src/site/markdown/faq.md b/modello-maven-plugin/src/site/markdown/faq.md index d748477a5..c729bb6e7 100644 --- a/modello-maven-plugin/src/site/markdown/faq.md +++ b/modello-maven-plugin/src/site/markdown/faq.md @@ -1,31 +1,35 @@ - - - - - - - - Where can I find documentation about Modello? - -

Modello model descriptor is described and documented with Modello.

- - - - - Is Modello really used anywhere? - -

- Modello is used extensively in Maven. You can find examples of models: -

-

- - - - - - +--- +title: Frequently Asked Questions +--- + +# Frequently Asked Questions + +1. [Where can I find documentation about Modello?](#question1) +2. [Is Modello really used anywhere?](#question2) + + + +### Where can I find documentation about Modello? + +The [Modello model descriptor](https://codehaus-plexus.github.io/modello/modello.html) is described and +documented with Modello. + + + +### Is Modello really used anywhere? + +Modello is used extensively in Maven. You can find examples of models: + +- [Maven's POM](https://maven.apache.org/ref/current/maven-model/maven.html): the mdo file for this model + is [`maven.mdo`](https://github.com/apache/maven/blob/master/api/maven-api-model/src/main/mdo/maven.mdo) + (Maven 4; the Maven 3 version is on the + [`maven-3.9.x` branch](https://github.com/apache/maven/blob/maven-3.9.x/maven-model/src/main/mdo/maven.mdo)) +- [Maven's settings](https://maven.apache.org/ref/current/maven-settings/settings.html): the mdo file for + this model is + [`settings.mdo`](https://github.com/apache/maven/blob/master/api/maven-api-settings/src/main/mdo/settings.mdo) +- [Maven assembly plugin](https://maven.apache.org/plugins/maven-assembly-plugin/): uses both an + [assembly model](https://github.com/apache/maven-assembly-plugin/blob/master/src/main/mdo/assembly.mdo) + and an + [assembly component model](https://github.com/apache/maven-assembly-plugin/blob/master/src/main/mdo/assembly-component.mdo) +- [Doxia site model](https://github.com/apache/maven-doxia-sitetools/blob/master/doxia-site-model/src/main/mdo/site.mdo), + the model behind `site.xml`