src/site/fml/faq.fml

<?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.
-->

<faqs xmlns="http://maven.apache.org/FML/1.0.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 https://maven.apache.org/xsd/fml-1.0.1.xsd"
  id="FAQ" title="Frequently Asked Questions">
  <part id="General">
    <faq id="question1">
      <question>Why do I need to use this plugin?</question>
      <answer>
        <p>
          This plugin greatly reduces the pain associated with consistent packaging concerns across
          a large set of projects, or an entire organization. Any project can specify the use of a
          remote resource bundle and have the resources incorporated into their packaging. This means
          that you can create standard settings in a parent POM somewhere in the project hierarchy and
          have all projects use packaged common resources in a standard way like licenses, other legal
          notices and disclaimers, or anything else that may be common.
        </p>
      </answer>
    </faq>
    <faq id="question2">
      <question>The generated files have a lot of missing information.  Looking at the POMs from
        the dependencies, the information isn't there either.  What can I do?</question>
      <answer>
        <p>
          There are two solutions:
        </p>
        <ol>
          <li>
            File bugs with the projects that produced those artifacts to get them to fix them.  Also,
            file bugs with the
            <a href="https://issues.apache.org/jira/browse/MEV">Maven Evangelism</a>
            project to have the Maven people enhance the metadata in the repository.
          </li>
          <li>
            Use a supplemental data file.  You can create a file that contains the missing metadata.
            For example:
            <source><![CDATA[
              <supplementalDataModels>
                <supplement>
                  <project>
                    <groupId>com.sun.xml.bind</groupId>
                    <artifactId>jaxb-impl</artifactId>
                    <name>Sun JAXB Reference Implementation Runtime</name>
                    <organization>
                      <name>Sun Microsystems</name>
                      <url>http://www.sun.com/</url>
                    </organization>
                    <licenses>
                      <license>
                        <name>COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0</name>
                        <url>http://www.sun.com/cddl/cddl.html</url>
                      </license>
                    </licenses>
                  </project>
                </supplement>
              </supplementalDataModels>]]>
            </source>
            That location of that file can then be configured with the
            <code>supplementalModels</code> configuration element for the <code>process</code> goal.  The
            supplemental information is merged with the information provided from the repository.
          </li>
        </ol>
      </answer>
    </faq>
  </part>
</faqs>