(maven-shared-utils) 02/02: Port the index page from APT to Markdown

[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-utils.git

commit 6fe6844083836e4a41cd9a40ee5b0b2f892863e0
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 19:44:55 2026 +0200

    Port the index page from APT to Markdown
    
    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
    - the page needs no Velocity, so it is a plain .md and the title, which was
      ${project.name}, is now spelled out
    
    Verified by building the site before and after: the rendered page is
    unchanged.
---
 src/site/markdown/index.md | 61 ++++++++++++++++++----------------------------
 1 file changed, 24 insertions(+), 37 deletions(-)

diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 6fde828..dda5f55 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -1,47 +1,34 @@
- ------
- Introduction
- ------
- Kristian Rosenvold
- ------
- 2013-07-24
- ------
+<!--
+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.
+-->
 
+# Apache Maven Shared Utils
 
-${project.name}
+This project replaces [plexus-utils](https://codehaus-plexus.github.io/plexus-utils/) for Maven.
 
-   This project replaces {{{https://codehaus-plexus.github.io/plexus-utils/}plexus-utils}} for Maven.
+It is not a 100% API compatible replacement. We cleaned up methods, added generics, and removed unused code.
 
-   It is not a 100% API compatible replacement. We cleaned up methods, added generics, and removed unused code.
+This project adds new features, like [styled message API](./apidocs/org/apache/maven/shared/utils/logging/package-summary.html).
 
-   This project adds new features, like {{{./apidocs/org/apache/maven/shared/utils/logging/package-summary.html}styled message API}}.
+# Why?
 
-Why?
+plexus-utils consisted mostly of code that originated in various Apache projects. Maven Shared Utils is based on those original Apache-source implementations.
 
-   plexus-utils consisted mostly of code that originated in various Apache projects.
-   Maven Shared Utils is based on those original Apache-source implementations.
+# Why not commons?
 
-Why not commons?
-
-    We prefer code to use commons-* where appropriate. The plexus-utils versions became incompatible with the Commons versions over time. Migrating is not always a 1:1 operation. Migrating to Maven Shared Utils works in most cases as a 1:1 operation.
-
-  []
+We prefer code to use commons-* where appropriate. The plexus-utils versions became incompatible with the Commons versions over time. Migrating is not always a 1:1 operation. Migrating to Maven Shared Utils works in most cases as a 1:1 operation.