This is an automated email from the ASF dual-hosted git repository. mbuenger pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-site.git
The following commit(s) were added to refs/heads/master by this push: new b70a8fda [MNGSITE-50] Convert some .apt files to .md (#830) b70a8fda is described below commit b70a8fda4898166988e80a92635b6a0537a03e97 Author: Matthias Bünger <buk...@users.noreply.github.com> AuthorDate: Wed Jul 2 15:29:15 2025 +0200 [MNGSITE-50] Convert some .apt files to .md (#830) --- content/apt/maven-features.apt | 80 --------------- content/apt/run-maven/index.apt | 106 ------------------- content/apt/shared/index.apt | 85 ---------------- content/apt/skins/index.apt | 96 ----------------- content/apt/users/getting-help.apt | 113 --------------------- content/apt/users/index.apt | 61 ----------- content/markdown/run-maven/index.md | 90 ++++++++++++++++ content/markdown/shared/index.md | 49 +++++++++ content/markdown/skins/index.md | 69 +++++++++++++ content/markdown/users/getting-help.md | 94 +++++++++++++++++ content/markdown/users/index.md | 38 +++++++ content/markdown/what-is-maven.md | 26 +++++ content/site.xml | 1 - content/xdoc/index.xml.vm | 3 +- .../java/org/apache/maven/site/update/Update.java | 2 +- 15 files changed, 368 insertions(+), 545 deletions(-) diff --git a/content/apt/maven-features.apt b/content/apt/maven-features.apt deleted file mode 100644 index 75cda7bd..00000000 --- a/content/apt/maven-features.apt +++ /dev/null @@ -1,80 +0,0 @@ - ------ - Maven Features - ------ - Jason van Zyl - ------ - 2005-10-12 - ------ - -~~ 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: -~~ https://maven.apache.org/doxia/references/apt-format.html - -Feature Summary - - The following are the key features of Maven in a nutshell: - - * Simple project setup that follows best practices - get a new project or module started in seconds - - * Consistent usage across all projects - means no ramp up time for new developers coming onto a project - - * Superior dependency management including automatic updating, dependency closures (also known as transitive dependencies) - - * Able to easily work with multiple projects at the same time - - * A {{{/repository/}large and growing repository of libraries and metadata}} to use out of the box, and arrangements in place with the largest Open Source projects for - real-time availability of their latest releases - - * Extensible, with the ability to easily {{{/plugin-developers/}write plugins}} in Java or scripting languages - - * Instant access to new features with little or no extra configuration - - * Ant tasks for dependency management and deployment outside of Maven - - * Model based builds: - Maven is able to build any number of projects into predefined output types - such as a JAR, WAR, or distribution based on metadata about the project, without - the need to do any scripting in most cases. - - * Coherent site of project information: - Using the same metadata as for the build process, Maven is able to generate a - web site or PDF including any documentation you care to add, and adds to that - standard reports about the state of development of the project. - Examples of this information can be seen at the bottom of the left-hand navigation of - this site under the "Project Information" and "Project Reports" submenus. - - * Release management and distribution publication: - Without much additional configuration, Maven will integrate with your source control - system (such as Subversion or Git) and manage the release of a project based on a certain tag. - It can also publish this to a distribution location for use by other projects. - Maven is able to publish individual outputs such as a JAR, an archive including other - dependencies and documentation, or as a source distribution. - - * Dependency management: - Maven encourages the use of a central repository of JARs and other dependencies. Maven - comes with a mechanism that your project's clients can use to - download any JARs required for building your project from a - central JAR repository much like Perl's CPAN. This allows users - of Maven to reuse JARs across projects and encourages communication - between projects to ensure that backward compatibility issues are - dealt with. - - [] - -~~ this needs to be greatly expanded and is too detailed here ... jvz diff --git a/content/apt/run-maven/index.apt b/content/apt/run-maven/index.apt deleted file mode 100644 index b4019a94..00000000 --- a/content/apt/run-maven/index.apt +++ /dev/null @@ -1,106 +0,0 @@ - ----- - Running Maven - ----- - Brett Porter - ----- - 2006-11-03 - ----- - -~~ 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 - -Building a Project with Maven - - The vast majority of Maven-built projects can be built with the following command: - ----- -mvn verify ----- - - This command tells Maven to build all the modules, and to check if all integration tests succeeded (when any was defined) - - That's it! If you look in the <<<target>>> subdirectory, you should find the build output and the final library or - application that was being built. - - <<Note:>> Some projects have multiple modules, so the library or application you are looking for may be in a module - subdirectory. - - While this will build most projects and Maven encourages this standard convention, builds can be customisable. If this - does not suffice, please consult the project's documentation. - -* More than just the Build - - Maven can do more than just build software - it can assist with testing, run web applications and produce reports on - projects, as well as any number of other tasks provided by plug-ins. - -* When Things go Wrong - - The following are some common problems when building with Maven, and how to resolve them. - -** Missing Dependencies - - A missing dependency presents with an error like the following: - ------ -[INFO] Failed to resolve artifact. - -Missing: - ---------- -1) jnuit:junit:jar:3.8.1 - - Try downloading the file manually from the project website. - - Then, install it using the command: - mvn install:install-file -DgroupId=jnuit -DartifactId=junit \ - -Dversion=3.8.1 -Dpackaging=jar -Dfile=/path/to/file - - Path to dependency: - 1) org.apache.maven:maven:pom:2.1-SNAPSHOT - 2) jnuit:junit:jar:3.8.1 - - ---------- -1 required artifact is missing. - -for artifact: - org.apache.maven:maven:pom:2.1-SNAPSHOT - -from the specified remote repositories: - central (https://repo.maven.apache.org/maven2) ------ - - To resolve this issue, it depends on what the dependency is and why it is missing. The most common cause is because - it can not be redistributed from the repository and must be manually installed using the instructions given in the - message. This is most common with some older JARs from Sun (usually <<<javax.*>>> group IDs), and is further - documented in the {{{../guides/mini/guide-coping-with-sun-jars.html} Guide to Coping with Sun JARs}}. - - You can check the list of repositories at the end of the error to ensure that the expected ones are listed - it may - be that the project requires an alternative repository that has not been declared properly or is not accessible with - your Maven configuration. - - In other cases, it may be an incorrectly declared dependency (like the typo in the example above) which the project - would need to fix, like a compilation error. - -** Inconsistent output - - Most plugins are optimized to know if they have to execute their task. In some cases, the output can be polluted from - a previous build and the end result is not what you expected. In such rare situations, you can call the <<<clean>>> phase - which means: remove the output directory. - You can also call it as <<<mvn clean verify>>> which means: first clean up the output directory, next build the project - and verify the outcome. diff --git a/content/apt/shared/index.apt b/content/apt/shared/index.apt deleted file mode 100644 index 77eb7209..00000000 --- a/content/apt/shared/index.apt +++ /dev/null @@ -1,85 +0,0 @@ - ----- - Shared Components - ----- - Dennis Lundberg - John Casey - Karl Heinz Marbaise - ----- - 2017-05-03 - ----- - -~~ 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: -~~ https://maven.apache.org/doxia/references/apt-format.html - -Shared Components - - The shared components are currently under transition to Maven 3.x only components. - -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -|| <<Shared Component>> || <<Version>> || <<Release Date>> || <<Description>> || <<Source Repository>> || <<Issue Tracking>> | -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/file-management/} <<<file-management>>>}} | 3.2.0 | 2025-04-13 | API to collect files from a given directory using several include/exclude rules. | {{{https://gitbox.apache.org/repos/asf/maven-file-management.git}Git}} / {{{https://github.com/apache/maven-file-management/}GitHub}} | {{{https://github.com/apache/maven-file-management/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-archiver/} <<<maven-archiver>>>}} | 3.6.3 | 2024-10-22 | Is mainly used by plugins to handle packaging. | {{{https://gitbox.apache.org/repos/asf/maven-archiver.git}Git}} / {{{https://github.com/apache/maven-archiver/}GitHub}} | {{{https://github.com/apache/maven-archiver/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-artifact-transfer/} <<<maven-artifact-transfer>>>}} | 0.13.1 | 2020-12-26 | An API to install, deploy and resolve artifacts with Maven | {{{https://gitbox.apache.org/repos/asf/maven-artifact-transfer.git}Git}} / {{{https://github.com/apache/maven-artifact-transfer/}GitHub}} | {{{https://issues.apache.org/jira/issues/?jql=project = MSHARED AND status != Closed AND component = maven-artifact-transfer}JIRA}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-common-artifact-filters/} <<<maven-common-artifact-filters>>>}} | 3.4.0 | 2024-06-05 | Filters lists of Artifact instances. | {{{https://gitbox.apache.org/repos/asf/maven-common-artifact-filters.git}Git}} / {{{https://github.com/apache/maven-common-artifact-filters/}GitHub}} | {{{https://github.com/apache/maven-common-artifact-filters/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-dependency-analyzer/} <<<maven-dependency-analyzer>>>}} | 1.16.0 | 2025-04-14 | Maven Dependency Analyzer component. | {{{https://gitbox.apache.org/repos/asf/maven-dependency-analyzer.git}Git}} / {{{https://github.com/apache/maven-dependency-analyzer/}GitHub}} | {{{https://github.com/apache/maven-dependency-analyzer/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-dependency-tree/} <<<maven-dependency-tree>>>}} | 3.3.0 | 2024-05-29 | Maven Dependency Tree constructs a tree model of a Maven project's dependencies. | {{{https://gitbox.apache.org/repos/asf/maven-dependency-tree.git}Git}} / {{{https://github.com/apache/maven-dependency-tree/}GitHub}} | {{{https://github.com/apache/maven-dependency-tree/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/doxia/doxia-sitetools/doxia-integration-tools/} <<<maven-doxia-tools>>>}} | | | moved to {{{/doxia/doxia-sitetools/doxia-integration-tools/} <<<doxia-integration-tools>>>}} | | -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-filtering/} <<<maven-filtering>>>}} | 3.4.0 | 2024-08-28 | Components for filtering resources. | {{{https://gitbox.apache.org/repos/asf/maven-filtering.git}Git}} / {{{https://github.com/apache/maven-filtering/}GitHub}} | {{{https://github.com/apache/maven-filtering/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-invoker/} <<<maven-invoker>>>}} | 3.3.0 | 2024-05-07 | Fires up a Maven build in a new JVM. | {{{https://gitbox.apache.org/repos/asf/maven-invoker.git}Git}} / {{{https://github.com/apache/maven-invoker/}GitHub}} | {{{https://github.com/apache/maven-invoker/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-jarsigner/} <<<maven-jarsigner>>>}} | 3.1.0 | 2024-08-15 | This component provides some utilities to sign/verify jars/files in your Mojos. | {{{https://gitbox.apache.org/repos/asf/maven-jarsigner.git}Git}} / {{{https://github.com/apache/maven-jarsigner/}GitHub}} | {{{https://github.com/apache/maven-jarsigner/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-mapping/} <<<maven-mapping>>>}} | 3.0.0 | 2015-11-19 | A shared component for all plugins that need to do mapping. | {{{https://gitbox.apache.org/repos/asf/maven-mapping.git}Git}} / {{{https://github.com/apache/maven-mapping/}GitHub}} | {{{https://issues.apache.org/jira/issues/?jql=project = MSHARED AND status != Closed AND component = maven-mapping}JIRA}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-reporting-api/} <<<maven-reporting-api>>>}} | 4.0.0 | 2024-10-01 | API to manage report generation. | {{{https://gitbox.apache.org/repos/asf/maven-reporting-api.git}Git}} / {{{https://github.com/apache/maven-reporting-api/}GitHub}} | {{{https://github.com/apache/maven-reporting-api/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-reporting-exec/} <<<maven-reporting-exec>>>}} | 2.0.0 | 2024-10-15 | API to manage report plugins preparation with Maven 3. | {{{https://gitbox.apache.org/repos/asf/maven-reporting-exec.git}Git}} / {{{https://github.com/apache/maven-reporting-exec/}GitHub}} | {{{https://github.com/apache/maven-reporting-exec/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-reporting-impl/} <<<maven-reporting-impl>>>}} | 4.0.0 | 2024-10-12 | Abstract classes to manage report generation. | {{{https://gitbox.apache.org/repos/asf/maven-reporting-impl.git}Git}} / {{{https://github.com/apache/maven-reporting-impl/}GitHub}} | {{{https://github.com/apache/maven-reporting-impl/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-script-interpreter/} <<<maven-script-interpreter>>>}} | 1.6 | 2024-04-29 | Utilities to interpret/execute some scripts for various implementations: groovy or beanshell. | {{{https://gitbox.apache.org/repos/asf/maven-script-interpreter.git}Git}} / {{{https://github.com/apache/maven-script-interpreter/}GitHub}} | {{{https://github.com/apache/maven-script-interpreter/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-shared-incremental/} <<<maven-shared-incremental>>>}} | 1.1 | 2013-04-08 | Various utility classes and plexus components for supporting incremental build functionality in Maven plugins. | {{{https://gitbox.apache.org/repos/asf/maven-shared-incremental.git}Git}} / {{{https://github.com/apache/maven-shared-incremental/}GitHub}} | {{{https://github.com/apache/maven-shared-incremental/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-shared-jar/} <<<maven-shared-jar>>>}} | 3.2.0 | 2024-12-30 | Utilities which help identify the contents of a JAR, including Java class analysis and Maven metadata analysis. | {{{https://gitbox.apache.org/repos/asf/maven-shared-jar.git}Git}} / {{{https://github.com/apache/maven-shared-jar/}GitHub}} | {{{https://github.com/apache/maven-shared-jar/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-shared-resources/} <<<maven-shared-resources>>>}} | 6 | 2024-06-08 | This is a collection of templates that are specific to the Maven project. | {{{https://gitbox.apache.org/repos/asf/maven-shared-resources.git}Git}} / {{{https://github.com/apache/maven-shared-resources/}GitHub}} | {{{https://github.com/apache/maven-shared-resources/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-shared-utils/} <<<maven-shared-utils>>>}} | 3.4.2 | 2023-05-11 | Utilities functions for use within Maven. | {{{https://gitbox.apache.org/repos/asf/maven-shared-utils.git}Git}} / {{{https://github.com/apache/maven-shared-utils/}GitHub}} | {{{https://github.com/apache/maven-shared-utils/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-shared-io/} <<<maven-shared-io>>>}} | 3.0.0 | 2015-12-23 | API for I/O support like logging, download or file scanning. | {{{https://gitbox.apache.org/repos/asf/maven-shared-io.git}Git}} / {{{https://github.com/apache/maven-shared-io/}GitHub}} | {{{https://github.com/apache/maven-shared-io/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/shared/maven-verifier/} <<<maven-verifier>>>}} | 2.0.0-M1 | 2022-09-22 | Used to run Maven builds as part of tests. | {{{https://gitbox.apache.org/repos/asf/maven-verifier.git}Git}} / {{{https://github.com/apache/maven-verifier/}GitHub}} | {{{https://github.com/apache/maven-verifier/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/scm/} <<<maven-scm>>>}} | 2.1.0 | 2024-04-11 | Generic API to SCM systems. | {{{https://gitbox.apache.org/repos/asf/maven-scm.git}Git}} / {{{https://github.com/apache/maven-scm/}GitHub}} | {{{https://github.com/apache/maven-scm/issues}GitHub Issues}} -*----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ - - - Archived version of shared libraries reference documentations are {{{../shared-archives/}located here}}. - diff --git a/content/apt/skins/index.apt b/content/apt/skins/index.apt deleted file mode 100644 index 8f398eb3..00000000 --- a/content/apt/skins/index.apt +++ /dev/null @@ -1,96 +0,0 @@ - ----- - Available Skins - ----- - Dennis Lundberg - Karl Heinz Marbaise - Michael Osipov - ----- - 2012-04-05 - ----- - -~~ 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: -~~ https://maven.apache.org/doxia/references/apt-format.html - -Available Skins - - The following table lists skins that are available for you to use in your - Maven generated site. - - <<Note: You always have to define a skin, if you are using a {{{/plugins/maven-site-plugin/examples/sitedescriptor.html}site descriptor}}. - There is no default skin applied automatically.>> - -* Maintained By The Maven Project - -*-------------------------------------------------------------------+--------------+----------------------+------------------+------------------------+--------------------+ -|| <<Skin>> || <<Version>> || Site Plugin Version || <<Description>> || <<Source Repository>> || <<Issue Tracking>> -*-------------------------------------------------------------------+--------------+----------------------+------------------+------------------------+--------------------+ -| {{{/skins/maven-fluido-skin/} <<<Maven Fluido Skin>>>}} | 2.1.0 | [3.21.0,) | Skin based on Bootstrap CSS. | {{{http://gitbox.apache.org/repos/asf/maven-fluido-skin.git}Git}} / {{{https://github.com/apache/maven-fluido-skin/}GitHub}} | {{{https://github.com/apache/maven-fluido-skin/issues}GitHub Issues}} -*-------------------------------------------------------------------+--------------+----------------------+------------------+------------------------+--------------------+ -| {{{/skins/maven-fluido-skin/} <<<Maven Fluido Skin>>>}} | 1.12.0 | [3.10.0,3.20.0) | Skin based on Bootstrap CSS. | {{{http://gitbox.apache.org/repos/asf/maven-fluido-skin.git/}Git}} / {{{https://github.com/apache/maven-fluido-skin/}GitHub}} | {{{https://github.com/apache/maven-fluido-skin/issues}GitHub Issues}} -*-------------------------------------------------------------------+--------------+----------------------+------------------+------------------------+--------------------+ - -** Retired - -*-------------------------------------------------------------------+--------------+----------------------+-------------------+------------------+ -|| <<Skin>> || <<Version>> || Site Plugin Version || <<Retired Date>> || <<Description>> -*-------------------------------------------------------------------+--------------+----------------------+-------------------+------------------+ -| {{{/skins/maven-default-skin/} <<<Maven Default Skin>>>}} (unofficially) | 1.3 | [3.5,3.20.0) | 2019-07-28 | Formerly, this skin got applied, if no skin was configured in the site descriptor. -*-------------------------------------------------------------------+--------------+----------------------+------------------+------------------------+--------------------+ -| {{{/skins/maven-application-skin/} <<<Maven Application Skin>>>}} | 1.0 | (,3.4] | 2015-12-28 |A skin used by applications like Continuum. -*-------------------------------------------------------------------+--------------+----------------------+-------------------+------------------+ -| {{{/skins/maven-classic-skin/} <<<Maven Classic Skin>>>}} | 1.1 | (,3.4] | 2015-12-28 | This skin resembles the look of a site generated by Maven 1. -*-------------------------------------------------------------------+--------------+----------------------+-------------------+------------------+ -| {{{/skins/maven-stylus-skin/} <<<Maven Stylus Skin>>>}} | 1.5 | (,3.4] | 2015-12-28 | The skin used for the website of Maven itself. -*-------------------------------------------------------------------+--------------+----------------------+-------------------+------------------+ - -* Outside The Maven Land - -*-------------------------------------------------------------------+----------------+-----------------------+ -|| <<Skin>> || <<Maintainer>> || <<Description>> -*-------------------------------------------------------------------+----------------+-----------------------+ -| {{{https://olamy.github.io/reflow-maven-skin/} <<<Reflow Maven Skin>>>}} | {{{https://github.com/olamy} Olivier Lamy}} | Responsive Apache Maven skin to reflow the standard Maven site with a modern feel. -*-------------------------------------------------------------------+----------------+-----------------------+ -| {{{https://devacfr.github.io/reflow-maven-skin/} <<<Reflow 2 Maven Skin>>>}} | {{{https://github.com/devacfr} Friederich Christophe}} | Responsive 2 Apache Maven skin to reflow the standard Maven site with a modern feel. -*-------------------------------------------------------------------+----------------+-----------------------+ -| {{{http://docs.bernardomg.com/maven/docs-maven-skin/} <<<Docs Maven Skin>>>}} | {{{https://github.com/Bernardo-MG} Bernardo Martínez Garrido}} | A minimalist and responsive Bootstrap-based HTML5 skin for Maven Site, which will help to use it as a documentation site. -*-------------------------------------------------------------------+----------------+-----------------------+ -| {{{https://stevecrox.github.io/maven-site-bootstrap-skin//} <<<Bootstrap Site Skin>>>}} | {{{https://github.com/stevecrox/maven-site-bootstrap-skin} Stephen Crocker}} | Responsive Maven Bootstrap Skin which has toggleable elements implemented based on the boostrap reference layouts. -*-------------------------------------------------------------------+----------------+-----------------------+ -| {{{https://sentrysoftware.org/sentry-maven-skin/} <<<Sentry Maven Skin>>>}} | {{{https://github.com/sentrysoftware/sentry-maven-skin} Sentry Software}} | Responsive skin, Bootstrap-based, with local search, light/dark colors switch, WEBP conversion, etc. -*-------------------------------------------------------------------+----------------+-----------------------+ - -* Instructions - - To apply one of these skins to your project's site, you use the <<<skin>>> element of the - {{{/plugins/maven-site-plugin/examples/sitedescriptor.html}site descriptor}}. - This is a regular artifact or dependency-like element. For example, to use the - Maven Fluido Skin, you would include the this in your <<<site.xml>>> file: - -+-----+ -<project> - ... - <skin> - <groupId>org.apache.maven.skins</groupId> - <artifactId>maven-fluido-skin</artifactId> - <version>2.1.0</version> - </skin> - ... -</project> -+-----+ diff --git a/content/apt/users/getting-help.apt b/content/apt/users/getting-help.apt deleted file mode 100644 index fddf9aa8..00000000 --- a/content/apt/users/getting-help.apt +++ /dev/null @@ -1,113 +0,0 @@ - ----- - Getting Help - ----- - Dennis Lundberg - Karl Heinz Marbaise - ----- - 2007-07-24 - 2015-06-17 - ----- - -~~ 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: -~~ https://maven.apache.org/doxia/references/apt-format.html - -Getting Help - - So something didn't work as you expected it to? You think that - <Maven is broken>. What should you do? - - Here's a list of actions that you can take: - -*You did check the documentation, didn't you? - - Apart from the central Maven site, each of our plugins has a website. Go - to the {{{../plugins/index.html}plugins page}} and follow the link to the - plugin you are having problems with. - -* Try the latest version of Maven or the plugin in question - - Before you start intensive investigations on your problem, you should try to update Maven and/or the plugins - in question to the latest stable release. After all, the issue you encounter might have been fixed already. - To find out what is the latest stable release version, consult {{{../download.html}Maven's download section}} - and the {{{../plugins/index.html}plugin index}}. - -*Search the user-list archives - - Someone else might have experienced the same problem as you before. A list - of mail-archives can be found on - {{{https://maven.apache.org/mailing-lists.html}mailing list index page}}. Please search one of - them before going any further. - -*Ask on the user list - - Our community is very helpful, just ask it the right way. See the references - section, at the end of this page, for info on how to do that. Subscribe to - the {{{https://maven.apache.org/mailing-lists.html}users-list}} and describe your - problem there. Don't expect to get an answer right away. Sometimes it takes a - couple of days. - -*Submit an issue - - If it turns out that there is indeed something wrong with Maven - or one of the plugins, you should report it to the issue management system. - All projects (Apache Maven core, Apache Maven plugins, sub components) have been migrated to use GitHub issues. - - You don't need create an issue only to ask us something - - in such case please first ask on {{{https://maven.apache.org/mailing-lists.html}users-list}} - -**Where? - - If the problem is in one of the plugins, check the site of that plugin to - get the correct link. Each plugin has its own GitHub repository, so using the - correct link is important. Click on <Project Information> and then - <Source Code Management>. On that page you will find the correct link. - - If the problem is in Maven itself you can find the appropriate link to GitHub repository on the - {{{https://maven.apache.org/scm.html}scm}} page. - -**How? - - Just describing the problem is not enough. It takes a developer a lot of - time to make a usable POM to even attempt to assess the problem. Issues - that states problems without something usable to try out will be closed as - incomplete. - - Please attach a working POM, or a set of POMs, that we can download and run. - We appreciate reports, but if you don't have something usable for us it's - incredibly hard for us to manage the issues. A POM goes a long way to helping - us resolve problems. - - Create a POM that can be used to verify that it is a bug. If your pom uses - plugins, make sure that you have specified the version for each and every - plugin. If you don't, then we might not be using the same version as you are - when we test it. - - What we like best are patches that fixes the problem. If you want to create a - patch for an issue please read the - {{{../guides/development/guide-maven-development.html}Maven Developer Guide}} first. - - If you have been able to figure out the changes needed for your problem or enhancement request, you can directly - create a Pull Request against the GitHub repository. - -* References - - * {{{http://www.catb.org/~esr/faqs/smart-questions.html}How To Ask Questions The Smart Way}} (Note: HTTP only!) - - * {{{http://opensourcestrategies.blogspot.com/2005/09/how-to-get-support-from-open-source.html}How to Get Support from Open Source Mailing Lists}} diff --git a/content/apt/users/index.apt b/content/apt/users/index.apt deleted file mode 100644 index c8f6c9d5..00000000 --- a/content/apt/users/index.apt +++ /dev/null @@ -1,61 +0,0 @@ - ----- - Users Centre - ----- - Brett Porter - ----- - 2006-11-03 - ----- - -~~ 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: -~~ https://maven.apache.org/doxia/references/apt-format.html - -Maven Users Centre - - This documentation centre is for those that have decided to use Maven to build their project, and would like to get - started quickly, or are already using Maven and would like to add new functionality or fix a problem in their build. - -~~TODO: tasks as buttons? - - * {{{../download.html} Download Maven}} - Download the latest version of Maven - - * {{{../guides/getting-started/maven-in-five-minutes.html} The 5 minute test}} - Learn how to use Maven in 5 minutes - - * {{{../guides/getting-started/index.html} Getting Started Tutorial}} - An in depth tutorial once you've learned the basics - - * {{{./getting-help.html} Getting Help}} - How to get help with Maven - -~~TODO: old getting started guide should become a beginners trail, and remove content covered in the 5 minute tutorial - -~~TODO: link to repository centre and plugin developers centre, and the reasons why they would progress there - -* Maven 4 - - * {{{/whatsnewinmaven4.html} What's new in Maven 4?}} - Compact overview about all changes of Maven 4 - - * {{{../guides/mini/guide-migration-to-mvn4.html} Migrate to Maven 4}} - Learn how to migrate projects to Maven 4 - - - -* Reference - - * {{{../pom.html} POM Reference}} - - * {{{../settings.html} Settings Reference}} - diff --git a/content/markdown/run-maven/index.md b/content/markdown/run-maven/index.md new file mode 100644 index 00000000..bb590d22 --- /dev/null +++ b/content/markdown/run-maven/index.md @@ -0,0 +1,90 @@ +<!-- 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--> + +# Building a Project with Maven + +The vast majority of Maven-built projects can be built with the following command: + +``` +mvn verify +``` + +This command tells Maven to build all the subprojects, and to check if all integration tests succeeded (when any was defined). +That's it! +If you look in the `target` subdirectory, you should find the build output and the final library or application that was being built. + +**Note:** Some projects have multiple subprojects, so the library or application you are looking for may be in a subproject's subdirectory. + +While this will build most projects and Maven encourages this standard convention, builds can be customisable. +If this does not suffice, please consult the project's documentation. + +## More than just the Build + +Maven can do more than just build software - it can assist with testing, run web applications and produce reports on projects, as well as any number of other tasks provided by plug-ins. + +## When Things go Wrong + +The following are some common problems when building with Maven, and how to resolve them. + +### Missing Dependencies + +A missing dependency presents with an error like the following: + +``` +[INFO] Failed to resolve artifact. + +Missing: + ---------- +1) jnuit:junit:jar:3.8.1 + + Try downloading the file manually from the project website. + + Then, install it using the command: + mvn install:install-file -DgroupId=jnuit -DartifactId=junit \ + -Dversion=3.8.1 -Dpackaging=jar -Dfile=/path/to/file + + Path to dependency: + 1) org.apache.maven:maven:pom:2.1-SNAPSHOT + 2) jnuit:junit:jar:3.8.1 + + ---------- +1 required artifact is missing. + +for artifact: + org.apache.maven:maven:pom:2.1-SNAPSHOT + +from the specified remote repositories: + central (https://repo.maven.apache.org/maven2) +``` + +To resolve this issue, it depends on what the dependency is and why it is missing. +The most common cause is because it can not be redistributed from the repository and must be manually installed using the instructions given in the message. +This is most common with some older JARs from Sun (usually `javax.*` group IDs), and is further documented in the [Guide to Coping with Sun JARs](../guides/mini/guide-coping-with-sun-jars.html). + +You can check the list of repositories at the end of the error to ensure that the expected ones are listed - it may be that the project requires an alternative repository that has not been declared properly or is not accessible with your Maven configuration. + +In other cases, it may be an incorrectly declared dependency (like the typo in the example above) which the project would need to fix, like a compilation error. + +### Inconsistent output + +Most plugins are optimized to know if they have to execute their task. +In some cases, the output can be polluted from a previous build and the end result is not what you expected. +In such rare situations, you can call the `clean` phase which means: remove the output directory. +You can also call it as `mvn clean verify` which means: first clean up the output directory, next build the project and verify the outcome. + diff --git a/content/markdown/shared/index.md b/content/markdown/shared/index.md new file mode 100644 index 00000000..81a433ca --- /dev/null +++ b/content/markdown/shared/index.md @@ -0,0 +1,49 @@ +<!-- 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:--> +<!-- https://maven.apache.org/doxia/references/apt-format.html--> + +# Shared Components + +The shared components are currently under transition to Maven 3.x only components. + +| **Shared Component** | **Version** | **Release Date** | **Description** | **Source Repository** | **Issue Tracking** [...] +|:---------------------------------------------------------------------------|:------------|:-----------------|:----------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------- [...] +| [ `file-management`](/shared/file-management/) | 3.2.0 | 2025-04-13 | API to collect files from a given directory using several include/exclude rules. | [Git](https://gitbox.apache.org/repos/asf/maven-file-management.git) / [GitHub](https://github.com/apache/maven-file-management/) | [GitHub Issues](https://github.com/apache/maven-file-management/issues) [...] +| [ `maven-archiver`](/shared/maven-archiver/) | 3.6.3 | 2024-10-22 | Is mainly used by plugins to handle packaging. | [Git](https://gitbox.apache.org/repos/asf/maven-archiver.git) / [GitHub](https://github.com/apache/maven-archiver/) | [GitHub Issues](https://github.com/apache/maven-archiver/issues) [...] +| [ `maven-artifact-transfer`](/shared/maven-artifact-transfer/) | 0.13.1 | 2020-12-26 | An API to install, deploy and resolve artifacts with Maven | [Git](https://gitbox.apache.org/repos/asf/maven-artifact-transfer.git) / [GitHub](https://github.com/apache/maven-artifact-transfer/) | [JIRA](https://issues.apache.org/jira/browse/MSHARED-1478?jql=project%3DMSHARED%20AND%20status%20!%3D%20Closed%20AND%2 [...] +| [ `maven-common-artifact-filters`](/shared/maven-common-artifact-filters/) | 3.4.0 | 2024-06-05 | Filters lists of Artifact instances. | [Git](https://gitbox.apache.org/repos/asf/maven-common-artifact-filters.git) / [GitHub](https://github.com/apache/maven-common-artifact-filters/) | [GitHub Issues](https://github.com/apache/maven-common-artifact-filters/issues) [...] +| [ `maven-dependency-analyzer`](/shared/maven-dependency-analyzer/) | 1.16.0 | 2025-04-14 | Maven Dependency Analyzer component. | [Git](https://gitbox.apache.org/repos/asf/maven-dependency-analyzer.git) / [GitHub](https://github.com/apache/maven-dependency-analyzer/) | [GitHub Issues](https://github.com/apache/maven-dependency-analyzer/issues) [...] +| [ `maven-dependency-tree`](/shared/maven-dependency-tree/) | 3.3.0 | 2024-05-29 | Maven Dependency Tree constructs a tree model of a Maven project's dependencies. | [Git](https://gitbox.apache.org/repos/asf/maven-dependency-tree.git) / [GitHub](https://github.com/apache/maven-dependency-tree/) | [GitHub Issues](https://github.com/apache/maven-dependency-tree/issues) [...] +| [ `maven-doxia-tools`](/doxia/doxia-sitetools/doxia-integration-tools/) | || moved to [ `doxia-integration-tools`](/doxia/doxia-sitetools/doxia-integration-tools/) || [...] +| [ `maven-filtering`](/shared/maven-filtering/) | 3.4.0 | 2024-08-28 | Components for filtering resources. | [Git](https://gitbox.apache.org/repos/asf/maven-filtering.git) / [GitHub](https://github.com/apache/maven-filtering/) | [GitHub Issues](https://github.com/apache/maven-filtering/issues) [...] +| [ `maven-invoker`](/shared/maven-invoker/) | 3.3.0 | 2024-05-07 | Fires up a Maven build in a new JVM. | [Git](https://gitbox.apache.org/repos/asf/maven-invoker.git) / [GitHub](https://github.com/apache/maven-invoker/) | [GitHub Issues](https://github.com/apache/maven-invoker/issues) [...] +| [ `maven-jarsigner`](/shared/maven-jarsigner/) | 3.1.0 | 2024-08-15 | This component provides some utilities to sign/verify jars/files in your Mojos. | [Git](https://gitbox.apache.org/repos/asf/maven-jarsigner.git) / [GitHub](https://github.com/apache/maven-jarsigner/) | [GitHub Issues](https://github.com/apache/maven-jarsigner/issues) [...] +| [ `maven-mapping`](/shared/maven-mapping/) | 3.0.0 | 2015-11-19 | A shared component for all plugins that need to do mapping. | [Git](https://gitbox.apache.org/repos/asf/maven-mapping.git) / [GitHub](https://github.com/apache/maven-mapping/) | [JIRA](https://issues.apache.org/jira/issues/?jql=project%20%3D%20MSHARED%20AND%20status%20!%3D%20Closed%20AND%20compo [...] +| [ `maven-reporting-api`](/shared/maven-reporting-api/) | 4.0.0 | 2024-10-01 | API to manage report generation. | [Git](https://gitbox.apache.org/repos/asf/maven-reporting-api.git) / [GitHub](https://github.com/apache/maven-reporting-api/) | [GitHub Issues](https://github.com/apache/maven-reporting-api/issues) [...] +| [ `maven-reporting-exec`](/shared/maven-reporting-exec/) | 2.0.0 | 2024-10-15 | API to manage report plugins preparation with Maven 3\. | [Git](https://gitbox.apache.org/repos/asf/maven-reporting-exec.git) / [GitHub](https://github.com/apache/maven-reporting-exec/) | [GitHub Issues](https://github.com/apache/maven-reporting-exec/issues) [...] +| [ `maven-reporting-impl`](/shared/maven-reporting-impl/) | 4.0.0 | 2024-10-12 | Abstract classes to manage report generation. | [Git](https://gitbox.apache.org/repos/asf/maven-reporting-impl.git) / [GitHub](https://github.com/apache/maven-reporting-impl/) | [GitHub Issues](https://github.com/apache/maven-reporting-impl/issues) [...] +| [ `maven-script-interpreter`](/shared/maven-script-interpreter/) | 1.6 | 2024-04-29 | Utilities to interpret/execute some scripts for various implementations: groovy or beanshell. | [Git](https://gitbox.apache.org/repos/asf/maven-script-interpreter.git) / [GitHub](https://github.com/apache/maven-script-interpreter/) | [GitHub Issues](https://github.com/apache/maven-script-interpreter/issues) [...] +| [ `maven-shared-incremental`](/shared/maven-shared-incremental/) | 1.1 | 2013-04-08 | Various utility classes and plexus components for supporting incremental build functionality in Maven plugins. | [Git](https://gitbox.apache.org/repos/asf/maven-shared-incremental.git) / [GitHub](https://github.com/apache/maven-shared-incremental/) | [GitHub Issues](https://github.com/apache/maven-shared-incremental/issues) [...] +| [ `maven-shared-jar`](/shared/maven-shared-jar/) | 3.2.0 | 2024-12-30 | Utilities which help identify the contents of a JAR, including Java class analysis and Maven metadata analysis. | [Git](https://gitbox.apache.org/repos/asf/maven-shared-jar.git) / [GitHub](https://github.com/apache/maven-shared-jar/) | [GitHub Issues](https://github.com/apache/maven-shared-jar/issues) [...] +| [ `maven-shared-resources`](/shared/maven-shared-resources/) | 6 | 2024-06-08 | This is a collection of templates that are specific to the Maven project. | [Git](https://gitbox.apache.org/repos/asf/maven-shared-resources.git) / [GitHub](https://github.com/apache/maven-shared-resources/) | [GitHub Issues](https://github.com/apache/maven-shared-resources/issues) [...] +| [ `maven-shared-utils`](/shared/maven-shared-utils/) | 3.4.2 | 2023-05-11 | Utilities functions for use within Maven. | [Git](https://gitbox.apache.org/repos/asf/maven-shared-utils.git) / [GitHub](https://github.com/apache/maven-shared-utils/) | [GitHub Issues](https://github.com/apache/maven-shared-utils/issues) [...] +| [ `maven-shared-io`](/shared/maven-shared-io/) | 3.0.0 | 2015-12-23 | API for I/O support like logging, download or file scanning. | [Git](https://gitbox.apache.org/repos/asf/maven-shared-io.git) / [GitHub](https://github.com/apache/maven-shared-io/) | [GitHub Issues](https://github.com/apache/maven-shared-io/issues) [...] +| [ `maven-verifier`](/shared/maven-verifier/) | 2.0.0-M1 | 2022-09-22 | Used to run Maven builds as part of tests. | [Git](https://gitbox.apache.org/repos/asf/maven-verifier.git) / [GitHub](https://github.com/apache/maven-verifier/) | [GitHub Issues](https://github.com/apache/maven-verifier/issues) [...] +| [ `maven-scm`](/scm/) | 2.1.0 | 2024-04-11 | Generic API to SCM systems. | [Git](https://gitbox.apache.org/repos/asf/maven-scm.git) / [GitHub](https://github.com/apache/maven-scm/) | [GitHub Issues](https://github.com/apache/maven-scm/issues) [...] + +Archived version of shared libraries reference documentations are [located here](../shared-archives/). diff --git a/content/markdown/skins/index.md b/content/markdown/skins/index.md new file mode 100644 index 00000000..8f0a47c4 --- /dev/null +++ b/content/markdown/skins/index.md @@ -0,0 +1,69 @@ +<!-- 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:--> +<!-- https://maven.apache.org/doxia/references/apt-format.html--> + +# Available Skins + +The following table lists skins that are available for you to use in your Maven generated site. + +**Note: You always have to define a skin, if you are using a [site descriptor](/plugins/maven-site-plugin/examples/sitedescriptor.html). There is no default skin applied automatically.** + +## Maintained By The Maven Project + +| **Skin** | **Version** | Site Plugin Version | **Description** | **Source Repository** | **Issue Tracking** | +|:--------------------------------------------------|:------------|:----------------------|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------| +| [ `Maven Fluido Skin`](/skins/maven-fluido-skin/) | 2\.1\.0 | \[3\.21\.0,\) | Skin based on Bootstrap CSS. | [Git](http://gitbox.apache.org/repos/asf/maven-fluido-skin.git) / [GitHub](https://github.com/apache/maven-fluido-skin/) | [GitHub Issues](https://github.com/apache/maven-fluido-skin/issues) | +| [ `Maven Fluido Skin`](/skins/maven-fluido-skin/) | 1\.12\.0 | \[3\.10\.0,3\.20\.0\) | Skin based on Bootstrap CSS. | [Git](http://gitbox.apache.org/repos/asf/maven-fluido-skin.git/) / [GitHub](https://github.com/apache/maven-fluido-skin/) | [GitHub Issues](https://github.com/apache/maven-fluido-skin/issues) | + +### Retired + +| **Skin** | **Version** | Site Plugin Version | **Retired Date** | **Description** | +|:---------------------------------------------------------------------|:------------|:--------------------|:-----------------|:-----------------------------------------------------------------------------------| +| [ `Maven Default Skin`](/skins/maven-default-skin/) \(unofficially\) | 1\.3 | \[3\.5,3\.20\.0\) | 2019-07-28 | Formerly, this skin got applied, if no skin was configured in the site descriptor. | +| [ `Maven Application Skin`](/skins/maven-application-skin/) | 1\.0 | \(,3\.4\] | 2015-12-28 | A skin used by applications like Continuum. | +| [ `Maven Classic Skin`](/skins/maven-classic-skin/) | 1\.1 | \(,3\.4\] | 2015-12-28 | This skin resembles the look of a site generated by Maven 1\. | +| [ `Maven Stylus Skin`](/skins/maven-stylus-skin/) | 1\.5 | \(,3\.4\] | 2015-12-28 | The skin used for the website of Maven itself. | + +## Outside The Maven Land + +| **Skin** | **Maintainer** | **Description** | +|:----------------------------------------------------------------------------------|:---------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| [ `Reflow Maven Skin`](https://olamy.github.io/reflow-maven-skin/) | [ Olivier Lamy](https://github.com/olamy) | Responsive Apache Maven skin to reflow the standard Maven site with a modern feel. | +| [ `Reflow 2 Maven Skin`](https://devacfr.github.io/reflow-maven-skin/) | [ Friederich Christophe](https://github.com/devacfr) | Responsive 2 Apache Maven skin to reflow the standard Maven site with a modern feel. | +| [ `Docs Maven Skin`](http://docs.bernardomg.com/maven/docs-maven-skin/) | [ Bernardo Martínez Garrido](https://github.com/Bernardo-MG) | A minimalist and responsive Bootstrap-based HTML5 skin for Maven Site, which will help to use it as a documentation site. | +| [ `Bootstrap Site Skin`](https://stevecrox.github.io/maven-site-bootstrap-skin//) | [ Stephen Crocker](https://github.com/stevecrox/maven-site-bootstrap-skin) | Responsive Maven Bootstrap Skin which has toggleable elements implemented based on the boostrap reference layouts. | +| [ `Sentry Maven Skin`](https://sentrysoftware.org/sentry-maven-skin/) | [ Sentry Software](https://github.com/sentrysoftware/sentry-maven-skin) | Responsive skin, Bootstrap-based, with local search, light/dark colors switch, WEBP conversion, etc. | + +## Instructions + +To apply one of these skins to your project's site, you use the `skin` element of the [site descriptor](/plugins/maven-site-plugin/examples/sitedescriptor.html). +This is a regular artifact or dependency-like element. +For example, to use the Maven Fluido Skin, you would include this in your `site.xml` file: + +```xml +<project> + ... + <skin> + <groupId>org.apache.maven.skins</groupId> + <artifactId>maven-fluido-skin</artifactId> + <version>2.1.0</version> + </skin> + ... +</project> +``` + diff --git a/content/markdown/users/getting-help.md b/content/markdown/users/getting-help.md new file mode 100644 index 00000000..5cf11e7c --- /dev/null +++ b/content/markdown/users/getting-help.md @@ -0,0 +1,94 @@ +<!-- +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. +--> + +# Getting Help + +So something didn't work as you expected it to? +You think that *Maven is broken*. +What should you do? + +Here's a list of actions that you can take: + +## You did check the documentation, didn't you? + +Apart from the central Maven site, each of our plugins has a website. +Go to the [plugins page](../plugins/index.html) and follow the link to the plugin you are having problems with. + +## Try the latest version of Maven or the plugin in question + +Before you start intensive investigations on your problem, you should try to update Maven and/or the plugins +in question to the latest stable release. +After all, the issue you encounter might have been fixed already. +To find out what is the latest stable release version, consult [Maven's download section](../download.html) +and the [plugins page](../plugins/index.html). + +## Search the user-list archives + +Someone else might have experienced the same problem as you before. +A list of mail-archives can be found on [mailing list index page](https://maven.apache.org/mailing-lists.html). +Please search one of them before going any further. + +## Ask on the user list + +Our community is very helpful, just ask it the right way. +See the references section, at the end of this page, for info on how to do that. +Subscribe to the [users list](https://maven.apache.org/mailing-lists.html) and describe your problem there. +Don't expect to get an answer right away. +Sometimes it takes a couple of days. + +## Submit an issue + +If it turns out that there is indeed something wrong with Maven or one of the plugins, you should report it to the issue management system. +All projects (Apache Maven core, Apache Maven plugins, subcomponents) have been migrated to use GitHub issues. + +You don't need to create an issue only to ask us something - in such case please first ask on [users list](https://maven.apache.org/mailing-lists.html). + +## Where? + +If the problem is in one of the plugins, check the site of that plugin to get the correct link. +Each plugin has its own GitHub repository, so using the correct link is important. +Click on *Project Information* and then *Source Code Management*. +On that page you will find the correct link. + +If the problem is in Maven itself you can find the appropriate link to GitHub repository on the [scm](/scm.html) page. + +## How? + +Just describing the problem is not enough. +It takes a developer a lot of time to make a usable POM to even attempt to assess the problem. +Issues that states problems without something usable to try out will be closed as incomplete. + +Please attach a working POM, or a set of POMs, that we can download and run. +We appreciate reports, but if you don't have something usable for us, it's incredibly hard for us to manage the issues. +A POM goes a long way to helping us resolve problems. + +Create a POM that can be used to verify that it is a bug. +If your pom uses plugins, make sure that you have specified the version for each and every plugin. +If you don't, then we might not be using the same version as you are when we test it. + +What we like best are patches that fixes the problem. +If you want to create a patch for an issue please read the [Maven Developer Guide](../guides/development/guide-maven-development.html) first. + +If you have been able to figure out the changes needed for your problem or enhancement request, you can directly create a Pull Request against the GitHub repository. + +## References + +* [Eric Steven Raymond - How To Ask Questions The Smart Way](http://www.catb.org/~esr/faqs/smart-questions.html) (Note: HTTP only!) +* [Blog: Open Source Strategies - How to Get Support from Open Source Mailing Lists](http://opensourcestrategies.blogspot.com/2005/09/how-to-get-support-from-open-source.html) (Note: HTTP only!) + diff --git a/content/markdown/users/index.md b/content/markdown/users/index.md new file mode 100644 index 00000000..0eac69be --- /dev/null +++ b/content/markdown/users/index.md @@ -0,0 +1,38 @@ +<!-- +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. +--> + +# Maven Users Centre + +This documentation centre is for those that have decided to use Maven to build their project, and would like to get started quickly, or are already using Maven and would like to add new functionality or fix a problem in their build. + +* [Download Maven](../download.html) - Download the latest version of Maven +* [Maven in five minutes](../guides/getting-started/maven-in-five-minutes.html) - Learn how to use Maven in 5 minutes +* [Getting Started Tutorial](../guides/getting-started/index.html) - An in depth tutorial once you've learned the basics +* [Getting Help](./getting-help.html) - How to get help with Maven + +## Maven 4 + +* [What's new in Maven 4?](/whatsnewinmaven4.html) - Compact overview about all changes of Maven 4 +* [Migrate to Maven 4](../guides/mini/guide-migration-to-mvn4.html) - Learn how to migrate projects to Maven 4 + +## Reference + +* [POM Reference](../pom.html) +* [Settings Reference](../settings.html) + diff --git a/content/markdown/what-is-maven.md b/content/markdown/what-is-maven.md index 8e2aff36..6972c2b2 100644 --- a/content/markdown/what-is-maven.md +++ b/content/markdown/what-is-maven.md @@ -99,6 +99,32 @@ If your project has an unusual build structure that cannot be reorganized, you may have to forgo some features or the use of Maven altogether. +## Feature summary + +The following are the key features of Maven in a nutshell: + +* Simple project setup that follows best practices - get a new project or module started in seconds- +* Consistent usage across all projects - means no ramp up time for new developers coming onto a project- +* Superior dependency management including automatic updating, dependency closures (also known as transitive dependencies)- +* Able to easily work with multiple projects at the same time- +* A [large and growing repository of libraries and metadata](/repository/) to use out of the box, and arrangements in place with the largest Open Source projects for real-time availability of their latest releases- +* Extensible, with the ability to easily [write plugins](/plugin-developers/) in Java or scripting languages- +* Instant access to new features with little or no extra configuration. +* Ant tasks for dependency management and deployment outside of Maven- +* Model based builds: + Maven is able to build any number of projects into predefined output types such as a JAR, WAR, or distribution based on metadata about the project, without the need to do any scripting in most cases. +* Coherent site of project information: + Using the same metadata as for the build process, Maven is able to generate a website or PDF including any documentation you care to add, and adds to that standard reports about the state of development of the project. + Examples of this information can be seen at the bottom of the left-hand navigation of this site under the "*Project Information*" and "*Project Reports*" submenus. +* Release management and distribution publication: + Without much additional configuration, Maven will integrate with your source control system (such as Subversion or Git) and manage the release of a project based on a certain tag. + It can also publish this to a distribution location for use by other projects. + Maven is able to publish individual outputs such as a JAR, an archive including other dependencies and documentation, or as a source distribution. +* Dependency management: + Maven encourages the use of a central repository of JARs and other dependencies. + Maven comes with a mechanism that your project's clients can use to download any JARs required for building your project from a central JAR repository much like Perl's CPAN. + This allows users of Maven to reuse JARs across projects and encourages communication between projects to ensure that backward compatibility issues are dealt with. + ## What is Maven Not? You might have heard some of the following things about Maven: diff --git a/content/site.xml b/content/site.xml index c607660d..45335809 100644 --- a/content/site.xml +++ b/content/site.xml @@ -43,7 +43,6 @@ under the License. <menu name="About Maven"> <item name="What is Maven?" href="/what-is-maven.html"/> - <item name="Features" href="/maven-features.html"/> <item name="Installation" href="/install.html" /> <item name="Downloads" href="/download.html"/> <item name="Use" href="/users/index.html" collapse="true"> diff --git a/content/xdoc/index.xml.vm b/content/xdoc/index.xml.vm index dec66f99..588575ca 100644 --- a/content/xdoc/index.xml.vm +++ b/content/xdoc/index.xml.vm @@ -35,8 +35,7 @@ under the License. </p> <p> You can find more information in the "About Maven" - section of the side bar. This includes an in-depth description of <a href="what-is-maven.html">what Maven is</a> and - a <a href="maven-features.html">list of some of its main features</a>. + section of the sidebar. This includes an in-depth description of <a href="what-is-maven.html">what Maven is</a> and a list of some of its main features. </p> <p> <!-- TODO: this could be the big button type thing instead of a list of links --> diff --git a/src/main/java/org/apache/maven/site/update/Update.java b/src/main/java/org/apache/maven/site/update/Update.java index fc1509b7..ffe23024 100644 --- a/src/main/java/org/apache/maven/site/update/Update.java +++ b/src/main/java/org/apache/maven/site/update/Update.java @@ -30,7 +30,7 @@ import org.jsoup.nodes.Document; import org.jsoup.nodes.Element; /** - * Updater for /plugins/index.apt and /shared/index.apt release numbers against + * Updater for /plugins/index.apt release numbers against * effective site content. */ public class Update {