Port the site documentation from APT to Markdown

core-it-suite/src/site/markdown/bootstrap.md.vm

@@ -0,0 +1,108 @@
+---
+title: Maven Core Integration Tests Bootstrap
+author: 
+  - Hervé Boutemy
+date: 2017-04-04
+---
+
+<!--
+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 Core Integration Tests Bootstrap
+
+Core IT Bootstrapping downloads from Central repository every dependency (artifacts, plugins) required to let Core ITs Suite run without downloading anything later (see [Core ITs Suite and dependencies](./index.html#Core_ITs_Suite_and_Dependencies_.28incl._Plugins.29) rationale).
+
+Content to download is defined in [a series of bootstrap projects](https://github.com/apache/maven-integration-testing/tree/master/core-it-suite/src/test/resources/bootstrap):
+
+<!-- MACRO{toc|section=1|fromDepth=2} -->
+
+Base Plugins And Their Dependencies
+-----------------------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/target/resolve-plugins.txt} -->
+
+Group 1 Dependencies
+--------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-1/target/resolve.txt} -->
+
+Group 2 Dependencies
+--------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-2/target/resolve.txt} -->
+
+Group 3 Dependencies
+--------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-3/target/resolve.txt} -->
+
+Group 4 Dependencies
+--------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-4/target/resolve.txt} -->
+
+Group 5 Dependencies
+--------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-5/target/resolve.txt} -->
+
+Group 6 Dependencies
+--------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-6/target/resolve.txt} -->
+
+Group 7 Dependencies
+--------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-7/target/resolve.txt} -->
+
+Group 8 Dependencies
+--------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-8/target/resolve.txt} -->
+
+Group 9 Dependencies
+--------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-9/target/resolve.txt} -->
+
+Group 10 Dependencies
+---------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-10/target/resolve.txt} -->
+
+Group 11 Dependencies
+---------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-11/target/resolve.txt} -->
+
+Group 12 Dependencies
+---------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-12/target/resolve.txt} -->
+
+Group 13 Dependencies
+---------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-13/target/resolve.txt} -->
+
+Group 14 Dependencies
+---------------------
+
+<!-- MACRO{snippet|file=${project.build.directory}/test-classes/bootstrap/group-14/target/resolve.txt} -->

core-it-suite/src/site/markdown/index.md.vm

@@ -0,0 +1,68 @@
+---
+title: Maven Core Integration Tests Suite
+author: 
+  - Hervé Boutemy
+date: 2011-09-04
+---
+
+<!--
+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 Core Integration Tests Suite
+
+This module provides the [effective Core Integration Tests suite](./testapidocs/org/apache/maven/it/package-summary.html), starting with [bootstrap](./bootstrap.html).
+
+Running Core ITs Suite
+----------------------
+
+Follow the steps that are described in the [README.md](https://github.com/apache/maven-integration-testing/blob/master/README.md) of the official [Core ITs Suite](https://github.com/apache/maven-integration-testing) repository.
+
+Core ITs Suite Results
+----------------------
+
+ITs results are displayed on the console and can be published in the site through Surefire Report.
+
+```shell
+mvn -Preporting site
+```
+
+Currently deployed [Surefire Report](./surefire-report.html) was generated with following environment:
+
+<!-- MACRO{snippet|file=${project.build.directory}/info.txt} -->
+
+Core ITs Suite and Dependencies (incl. Plugins)
+-----------------------------------------------
+
+A good IT does not depend on external repos like Central, it uses dedicated test plugins and test repositories. The [default `settings.xml`](https://github.com/apache/maven-integration-testing/blob/master/core-it-suite/src/test/resources-filtered/settings.xml) used by ITs helps to enforce this by pointing `central` at `file:target/null`, which obviously can't resolve anything. This setup using a file-based dummy repo also helps execution time, because this repo produces (expected) `404`s much faster than a HTTP-based repo.
+
+The one place where access to Central is desired is by adding artifacts to the [bootstrap.txt](https://github.com/apache/maven-integration-testing/blob/master/core-it-suite/src/test/resources/bootstrap.txt) file, which is used to prime the local repo with any artifacts the ITs will need. This file should be kept sorted alphabetically for ease of use.
+
+So some care needs to be taken when introducing new dependencies into the ITs themselves or [the support plugins](../core-it-support/). Many times the failures that we encounter are discrepancies between actual artifact consumption required and what is populated during bootstrapping. When forgetting, typical failures (as seen in ASF CI) will give following traces in log:
+
+```
+[ERROR] testit(org.apache.maven.it.MavenITmng...)  Time elapsed: 0.145 s  <<< ERROR!
+...
+[ERROR] Failed to execute goal ... (...) on project ...: ... Could not find artifact ... in central (file:target/null) -> [Help 1]
+```
+
+#[[### Using Local Repository Manager]]#
+
+If you are using a local repository manager, configured in your `~/.m2/settings.xml` as a mirror of `central`, it will invalidate previous setup: working Core ITs Suite can work on your laptop but fail on ASF CI because of missing artifact.
+
+Comment out your mirror configuration to enable the expected local failure, then be able to debug and fix the issue.

core-it-support/core-it-plugins/maven-it-plugin-core-stubs/src/site/markdown/index.md.vm

@@ -0,0 +1,12 @@
+---
+title: About
+author: 
+  - Hervé Boutemy
+date: 2012-10-13
+---
+
+# ${project.name}
+
+About ${project.description}
+
+See [Project Modules](./modules.html) report for a complete list with description.