This is an automated email from the ASF dual-hosted git repository. hboutemy pushed a commit to branch pr/master/site-links in repository https://gitbox.apache.org/repos/asf/maven.git
commit 316c13b6362ed6c295f4de295d5a63789c733d85 Author: Hervé Boutemy <[email protected]> AuthorDate: Sun Nov 16 18:39:19 2025 +0100 update links --- .../maven-api-cli}/src/site/apt/index.apt | 22 +++++++------ api/maven-api-cli/src/site/site.xml | 38 ++++++++++++++++++++++ api/maven-api-model/src/main/mdo/maven.mdo | 4 +-- api/maven-api-model/src/site/apt/index.apt | 2 +- api/maven-api-settings/src/site/apt/index.apt | 2 +- api/maven-api-toolchain/src/site/apt/index.apt | 2 +- compat/maven-model/src/site/apt/index.apt | 6 ++-- compat/maven-plugin-api/src/site/apt/index.apt | 2 +- .../src/site/apt/index.apt | 2 +- compat/maven-settings/src/site/apt/index.apt | 4 +-- .../maven-toolchain-model/src/site/apt/index.apt | 6 ++-- impl/maven-core/src/site/apt/artifact-handlers.apt | 8 ++--- impl/maven-executor/src/site/site.xml | 35 ++++++++++++++++++++ impl/maven-logging/src/site/apt/index.apt | 2 +- impl/maven-support/src/site/site.xml | 35 ++++++++++++++++++++ impl/maven-testing/src/site/site.xml | 35 ++++++++++++++++++++ 16 files changed, 175 insertions(+), 30 deletions(-) diff --git a/compat/maven-toolchain-model/src/site/apt/index.apt b/api/maven-api-cli/src/site/apt/index.apt similarity index 52% copy from compat/maven-toolchain-model/src/site/apt/index.apt copy to api/maven-api-cli/src/site/apt/index.apt index 81e22f7ce4..8d901b3525 100644 --- a/compat/maven-toolchain-model/src/site/apt/index.apt +++ b/api/maven-api-cli/src/site/apt/index.apt @@ -20,20 +20,22 @@ ----- Hervé Boutemy ----- - 2006-11-04 + 2025-11-16 ----- -Maven Toolchain Model +Maven 4 API - CLI - This is the model for Maven toolchain in <<<org.apache.maven.toolchain>>> package, - delegating content to {{{../api/maven-api-toolchain/index.html}Maven 4 API immutable toolchain}}. All the effective model - building logic from multiple toolchains files is done in {{{../maven-toolchain-builder/}Maven Toolchain Builder}}. + This is the {{{./apidocs/org/apache/maven/api/cli/package-summary.html}API}} for Maven's command-line interface and + tools: - The following are generated from this model: + * <<<{{{./apidocs/org/apache/maven/api/cli/mvn/package-summary.html}mvn}}>>>, the Maven build tool, - * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the Xpp3 XML parser, <<<ToAPiV3()>>> and <<<ToApiV4()>>> transformers, and <<<v4>>> package - for Merger and v4 Reader and Writers for the Xpp3 XML parser, + * <<<{{{./apidocs/org/apache/maven/api/cli/mvnenc/package-summary.html}mvnenc}}>>>, the Maven Password Encryption tool, - * A {{{./toolchains.html}Descriptor Reference}} + * <<<{{{./apidocs/org/apache/maven/api/cli/mvnsh/package-summary.html}mvnsh}}>>>, the Maven Shell tool, - * An {{{https://maven.apache.org/xsd/toolchains-1.1.0.xsd}XSD}} + * <<<{{{./apidocs/org/apache/maven/api/cli/mvnup/package-summary.html}mvnup}}>>>, the Maven Upgrade tool. + + This API also defines {{{./core-extensions.html}Core Extensions model}} for <<<.mvn/extensions.xml>>>. + + See also associated {{{../../impl/maven-cli/index.html}implementation}}. \ No newline at end of file diff --git a/api/maven-api-cli/src/site/site.xml b/api/maven-api-cli/src/site/site.xml new file mode 100644 index 0000000000..6a599fce2b --- /dev/null +++ b/api/maven-api-cli/src/site/site.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- +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. +--> + +<site xmlns="http://maven.apache.org/SITE/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd"> + + <edit>${project.scm.url}</edit> + + <body> + <menu name="Overview"> + <item name="Introduction" href="index.html"/> + <item name="Javadocs" href="apidocs/index.html"/> + <item name="Source Xref" href="xref/index.html"/> + <!--item name="FAQ" href="faq.html"/--> + </menu> + + <menu ref="parent"/> + <menu ref="reports"/> + </body> +</site> diff --git a/api/maven-api-model/src/main/mdo/maven.mdo b/api/maven-api-model/src/main/mdo/maven.mdo index 3a18900ac3..90e991a566 100644 --- a/api/maven-api-model/src/main/mdo/maven.mdo +++ b/api/maven-api-model/src/main/mdo/maven.mdo @@ -54,8 +54,8 @@ <p>This is a reference for the Maven project descriptor used in Maven.</p> <p>An XSD is available at:</p> <ul> - <li><a href="https://maven.apache.org/xsd/maven-4.0.0.xsd">https://maven.apache.org/xsd/maven-4.0.0.xsd</a> for Maven 3.0.</li> - <li><a href="https://maven.apache.org/xsd/maven-4.1.0.xsd">https://maven.apache.org/xsd/maven-4.1.0.xsd</a> for Maven 4.0.</li> + <li><a href="https://maven.apache.org/xsd/maven-4.0.0.xsd">https://maven.apache.org/xsd/maven-4.0.0.xsd</a> for Maven 3.</li> + <li><a href="https://maven.apache.org/xsd/maven-4.1.0.xsd">https://maven.apache.org/xsd/maven-4.1.0.xsd</a> for Maven 4.</li> </ul> ]]> </description> diff --git a/api/maven-api-model/src/site/apt/index.apt b/api/maven-api-model/src/site/apt/index.apt index e64b4fb211..5720df24da 100644 --- a/api/maven-api-model/src/site/apt/index.apt +++ b/api/maven-api-model/src/site/apt/index.apt @@ -33,4 +33,4 @@ Maven 4 API - Immutable Maven Model * {{{./apidocs/index.html}Java sources}} with <<<Builder>>> inner classes for immutable instances creation. - See also corresponding {{{../../maven-model/index.html}Maven classical POM model documentation}}. + See also corresponding {{{../../compat/maven-model/index.html}Maven classical POM model documentation}}. diff --git a/api/maven-api-settings/src/site/apt/index.apt b/api/maven-api-settings/src/site/apt/index.apt index ca71c0d7f7..b650c8e1c9 100644 --- a/api/maven-api-settings/src/site/apt/index.apt +++ b/api/maven-api-settings/src/site/apt/index.apt @@ -31,5 +31,5 @@ Maven 4 API - Immutable Settings Model * {{{./apidocs/index.html}Java sources}} with <<<Builder>>> inner classes for immutable instances creation. - See also corresponding {{{../../maven-settings/index.html}Maven classical settings model documentation}}. + See also corresponding {{{../../compat/maven-settings/index.html}Maven classical settings model documentation}}. \ No newline at end of file diff --git a/api/maven-api-toolchain/src/site/apt/index.apt b/api/maven-api-toolchain/src/site/apt/index.apt index 689b044330..f1a76e9c98 100644 --- a/api/maven-api-toolchain/src/site/apt/index.apt +++ b/api/maven-api-toolchain/src/site/apt/index.apt @@ -31,5 +31,5 @@ Maven 4 API - Immutable Toolchains Model * {{{./apidocs/index.html}Java sources}} with <<<Builder>>> inner classes for immutable instances creation. - See also corresponding {{{../../maven-toolchain-model/index.html}Maven classical toolchains model documentation}}. + See also corresponding {{{../../compat/maven-toolchain-model/index.html}Maven classical toolchains model documentation}}. \ No newline at end of file diff --git a/compat/maven-model/src/site/apt/index.apt b/compat/maven-model/src/site/apt/index.apt index 680358f0e0..0d33ae5194 100644 --- a/compat/maven-model/src/site/apt/index.apt +++ b/compat/maven-model/src/site/apt/index.apt @@ -28,7 +28,7 @@ Maven Model This is strictly the model for Maven POM (Project Object Model) in <<<org.apache.maven.model>>> package, - delegating content to {{{../api/maven-api-model/index.html}Maven 4 API immutable model}}. All the effective model + delegating content to {{{../../api/maven-api-model/index.html}Maven 4 API immutable model}}. All the effective model building logic from multiple POMs and building context is done in {{{../maven-model-builder/}Maven Model Builder}}. The following are generated from this model: @@ -36,6 +36,6 @@ Maven Model * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the Xpp3 XML parser, <<<ToAPiV3()>>> and <<<ToApiV4()>>> transformers, and <<<v4>>> package for Merger and v4 Reader and Writers for the Xpp3 XML parser, - * A {{{./maven.html}Descriptor Reference}} + * A {{{../../api/maven-api-model/maven.html}Descriptor Reference}} - * An XSD {{{https://maven.apache.org/xsd/maven-v3_0_0.xsd}for Maven 1.1}} and {{{https://maven.apache.org/xsd/maven-4.0.0.xsd}for Maven 2.0}}. + * An XSD {{{https://maven.apache.org/xsd/maven-v3_0_0.xsd}for Maven 1.1}} and {{{https://maven.apache.org/xsd/maven-4.0.0.xsd}for Maven 2 and 3}}. diff --git a/compat/maven-plugin-api/src/site/apt/index.apt b/compat/maven-plugin-api/src/site/apt/index.apt index eaccae6eb8..aebf9ea28a 100644 --- a/compat/maven-plugin-api/src/site/apt/index.apt +++ b/compat/maven-plugin-api/src/site/apt/index.apt @@ -33,7 +33,7 @@ Maven 3 Plugin API [] - A plugin is described in a {{{./plugin.html}<<<META-INF/maven/plugin.xml>>> plugin descriptor}}, + A plugin is described in a {{{../../api/maven-api-plugin/plugin.html}<<<META-INF/maven/plugin.xml>>> plugin descriptor}}, generally generated from plugin sources using {{{/plugin-tools/maven-plugin-plugin/}maven-plugin-plugin}}. * See Also diff --git a/compat/maven-repository-metadata/src/site/apt/index.apt b/compat/maven-repository-metadata/src/site/apt/index.apt index 56fc874de4..fb6f37f97c 100644 --- a/compat/maven-repository-metadata/src/site/apt/index.apt +++ b/compat/maven-repository-metadata/src/site/apt/index.apt @@ -53,7 +53,7 @@ Maven Repository Metadata Model * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the Xpp3 XML parser, to read and write <<<maven-metadata(-*).xml>>> files, - * a {{{./repository-metadata.html}Descriptor Reference}}. + * a {{{../../api/maven-api-metadata/repository-metadata.html}Descriptor Reference}}. For more information see this page: {{{https://maven.apache.org/repositories/metadata.html}Maven Metadata}}. diff --git a/compat/maven-settings/src/site/apt/index.apt b/compat/maven-settings/src/site/apt/index.apt index 1aed2a9b5d..bd84dd8036 100644 --- a/compat/maven-settings/src/site/apt/index.apt +++ b/compat/maven-settings/src/site/apt/index.apt @@ -26,7 +26,7 @@ Maven Settings Model This is the model for Maven settings in <<<org.apache.maven.settings>>> package, - delegating content to {{{../api/maven-api-settings/index.html}Maven 4 API immutable settings}}. All the effective model + delegating content to {{{../../api/maven-api-settings/index.html}Maven 4 API immutable settings}}. All the effective model building logic from multiple settings files is done in {{{../maven-settings-builder/}Maven Settings Builder}}. The following are generated from this model: @@ -36,7 +36,7 @@ Maven Settings Model * A {{{../../api/maven-api-settings/settings.html}Descriptor Reference}} - * An {{{https://maven.apache.org/xsd/settings-2.0.0-rc-2.xsd}XSD}} + * An {{{https://maven.apache.org/xsd/settings-2.0.0.xsd}XSD}} * See Also User Documentation diff --git a/compat/maven-toolchain-model/src/site/apt/index.apt b/compat/maven-toolchain-model/src/site/apt/index.apt index 81e22f7ce4..b3f74172af 100644 --- a/compat/maven-toolchain-model/src/site/apt/index.apt +++ b/compat/maven-toolchain-model/src/site/apt/index.apt @@ -26,7 +26,7 @@ Maven Toolchain Model This is the model for Maven toolchain in <<<org.apache.maven.toolchain>>> package, - delegating content to {{{../api/maven-api-toolchain/index.html}Maven 4 API immutable toolchain}}. All the effective model + delegating content to {{{../../api/maven-api-toolchain/index.html}Maven 4 API immutable toolchain}}. All the effective model building logic from multiple toolchains files is done in {{{../maven-toolchain-builder/}Maven Toolchain Builder}}. The following are generated from this model: @@ -34,6 +34,6 @@ Maven Toolchain Model * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the Xpp3 XML parser, <<<ToAPiV3()>>> and <<<ToApiV4()>>> transformers, and <<<v4>>> package for Merger and v4 Reader and Writers for the Xpp3 XML parser, - * A {{{./toolchains.html}Descriptor Reference}} + * A {{{../../api/maven-api-toolchain/toolchains.html}Descriptor Reference}} - * An {{{https://maven.apache.org/xsd/toolchains-1.1.0.xsd}XSD}} + * An {{{https://maven.apache.org/xsd/toolchains-1.2.0.xsd}XSD}} diff --git a/impl/maven-core/src/site/apt/artifact-handlers.apt b/impl/maven-core/src/site/apt/artifact-handlers.apt index b1b1bce156..3323c1dc1f 100644 --- a/impl/maven-core/src/site/apt/artifact-handlers.apt +++ b/impl/maven-core/src/site/apt/artifact-handlers.apt @@ -25,12 +25,12 @@ Legacy Artifact Handlers Reference - Maven 3 artifact handlers (see {{{../maven-artifact/apidocs/org/apache/maven/artifact/handler/ArtifactHandler.html} API}}) - define for each {{{../maven-model/maven.html#class_dependency}dependency type}} information on the artifact + Maven 3 artifact handlers (see {{{../../compat/maven-artifact/apidocs/org/apache/maven/artifact/handler/ArtifactHandler.html} API}}) + define for each {{{../../api/maven-api-model/maven.html#class_dependency}dependency type}} information on the artifact (classifier, extension, language) and how to manage it as dependency (add to classpath, include dependencies). - They are replaced in Maven 4 with Maven 4 API Core's {{{../api/maven-api-core/apidocs/org/apache/maven/api/Type.html}Dependency Types}}, - with default values defined in {{{../maven-resolver-provider/apidocs/org/apache/maven/repository/internal/type/DefaultTypeProvider.html}DefaultTypeProvider}}. + They are replaced in Maven 4 with Maven 4 API Core's {{{../../api/maven-api-core/apidocs/org/apache/maven/api/Type.html}Dependency Types}}, + with default values defined in {{{../../compat/maven-resolver-provider/apidocs/org/apache/maven/repository/internal/type/DefaultTypeProvider.html}DefaultTypeProvider}}. For compatibility, legacy Maven 3 artifact handlers are still provided: diff --git a/impl/maven-executor/src/site/site.xml b/impl/maven-executor/src/site/site.xml new file mode 100644 index 0000000000..4ee3b709cf --- /dev/null +++ b/impl/maven-executor/src/site/site.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- +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. +--> + +<site xmlns="http://maven.apache.org/SITE/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd"> + + <edit>${project.scm.url}</edit> + + <body> + <menu name="Overview"> + <item name="Introduction" href="index.html"/> + <item name="Javadocs" href="apidocs/index.html"/> + <item name="Source Xref" href="xref/index.html"/> + <!--item name="FAQ" href="faq.html"/--> + </menu> + </body> +</site> diff --git a/impl/maven-logging/src/site/apt/index.apt b/impl/maven-logging/src/site/apt/index.apt index 802632a9c0..01a29ee1bb 100644 --- a/impl/maven-logging/src/site/apt/index.apt +++ b/impl/maven-logging/src/site/apt/index.apt @@ -32,4 +32,4 @@ Maven SLF4J Provider * See Also - * {{{../maven-embedder/logging.html}Maven Logging}} + * {{{../../compat/maven-embedder/logging.html}Maven Logging}} diff --git a/impl/maven-support/src/site/site.xml b/impl/maven-support/src/site/site.xml new file mode 100644 index 0000000000..4ee3b709cf --- /dev/null +++ b/impl/maven-support/src/site/site.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- +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. +--> + +<site xmlns="http://maven.apache.org/SITE/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd"> + + <edit>${project.scm.url}</edit> + + <body> + <menu name="Overview"> + <item name="Introduction" href="index.html"/> + <item name="Javadocs" href="apidocs/index.html"/> + <item name="Source Xref" href="xref/index.html"/> + <!--item name="FAQ" href="faq.html"/--> + </menu> + </body> +</site> diff --git a/impl/maven-testing/src/site/site.xml b/impl/maven-testing/src/site/site.xml new file mode 100644 index 0000000000..4ee3b709cf --- /dev/null +++ b/impl/maven-testing/src/site/site.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- +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. +--> + +<site xmlns="http://maven.apache.org/SITE/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd"> + + <edit>${project.scm.url}</edit> + + <body> + <menu name="Overview"> + <item name="Introduction" href="index.html"/> + <item name="Javadocs" href="apidocs/index.html"/> + <item name="Source Xref" href="xref/index.html"/> + <!--item name="FAQ" href="faq.html"/--> + </menu> + </body> +</site>
