Repository: commons-testing Updated Branches: refs/heads/master 0eeb34038 -> 690fe3f7b
Typo: 'JavaDoc' -> 'Javadoc'. Project: http://git-wip-us.apache.org/repos/asf/commons-testing/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-testing/commit/690fe3f7 Tree: http://git-wip-us.apache.org/repos/asf/commons-testing/tree/690fe3f7 Diff: http://git-wip-us.apache.org/repos/asf/commons-testing/diff/690fe3f7 Branch: refs/heads/master Commit: 690fe3f7b70ea72c5b093fd51d77e14cde9d396d Parents: 0eeb340 Author: Gary Gregory <garydgreg...@gmail.com> Authored: Tue May 15 13:07:32 2018 -0600 Committer: Gary Gregory <garydgreg...@gmail.com> Committed: Tue May 15 13:07:32 2018 -0600 ---------------------------------------------------------------------- README.md | 210 ++++++++++++++--------------- src/site/xdoc/index.xml | 314 +++++++++++++++++++++---------------------- 2 files changed, 262 insertions(+), 262 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-testing/blob/690fe3f7/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 1b18183..fa0d1a1 100644 --- a/README.md +++ b/README.md @@ -1,105 +1,105 @@ -<!--- - 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. ---> -<!--- - +======================================================================+ - |**** ****| - |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| - |**** DO NOT EDIT DIRECTLY ****| - |**** ****| - +======================================================================+ - | TEMPLATE FILE: readme-md-template.md | - | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | - +======================================================================+ - | | - | 1) Re-generate using: mvn commons:readme-md | - | | - | 2) Set the following properties in the component's pom: | - | - commons.componentid (required, alphabetic, lower case) | - | - commons.release.version (required) | - | | - | 3) Example Properties | - | | - | <properties> | - | <commons.componentid>math</commons.componentid> | - | <commons.release.version>1.2</commons.release.version> | - | </properties> | - | | - +======================================================================+ ----> -Apache Commons Testing Parent POM -=================== - -[](https://travis-ci.org/apache/commons-testing-parent) -[](https://coveralls.io/r/apache/commons-testing-parent) -[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-testing-parent/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) - -Apache Commons Testing, a package of Java utility classes for testing. - -Documentation -------------- - -More information can be found on the [Apache Commons Testing Parent POM homepage](https://commons.apache.org/proper/commons-testing). -The [JavaDoc](https://commons.apache.org/proper/commons-testing/javadocs/api-release) can be browsed. -Questions related to the usage of Apache Commons Testing Parent POM should be posted to the [user mailing list][ml]. - -Where can I get the latest release? ------------------------------------ -You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-testing/download_testing.cgi). - -Alternatively you can pull it from the central Maven repositories: - -```xml -<dependency> - <groupId>org.apache.commons</groupId> - <artifactId>commons-testing-parent</artifactId> - <version>1.0.0</version> -</dependency> -``` - -Contributing ------------- - -We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. -There are some guidelines which will make applying PRs easier for us: -+ No tabs! Please use spaces for indentation. -+ Respect the code style. -+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change. -+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```. - -If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas). -You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). - -License -------- -This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). - -See the `NOTICE.txt` file for required notices and attributions. - -Donations ---------- -You like Apache Commons Testing Parent POM? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. - -Additional Resources --------------------- - -+ [Apache Commons Homepage](https://commons.apache.org/) -+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/TESTING) -+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ `#apache-commons` IRC channel on `irc.freenode.org` - -[ml]:https://commons.apache.org/mail-lists.html +<!--- + 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. +--> +<!--- + +======================================================================+ + |**** ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| + |**** DO NOT EDIT DIRECTLY ****| + |**** ****| + +======================================================================+ + | TEMPLATE FILE: readme-md-template.md | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | + +======================================================================+ + | | + | 1) Re-generate using: mvn commons:readme-md | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | - commons.release.version (required) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | + | </properties> | + | | + +======================================================================+ +---> +Apache Commons Testing Parent POM +=================== + +[](https://travis-ci.org/apache/commons-testing-parent) +[](https://coveralls.io/r/apache/commons-testing-parent) +[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-testing-parent/) +[](http://www.apache.org/licenses/LICENSE-2.0.html) + +Apache Commons Testing, a package of Java utility classes for testing. + +Documentation +------------- + +More information can be found on the [Apache Commons Testing Parent POM homepage](https://commons.apache.org/proper/commons-testing). +The [Javadoc](https://commons.apache.org/proper/commons-testing/javadocs/api-release) can be browsed. +Questions related to the usage of Apache Commons Testing Parent POM should be posted to the [user mailing list][ml]. + +Where can I get the latest release? +----------------------------------- +You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-testing/download_testing.cgi). + +Alternatively you can pull it from the central Maven repositories: + +```xml +<dependency> + <groupId>org.apache.commons</groupId> + <artifactId>commons-testing-parent</artifactId> + <version>1.0.0</version> +</dependency> +``` + +Contributing +------------ + +We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. +There are some guidelines which will make applying PRs easier for us: ++ No tabs! Please use spaces for indentation. ++ Respect the code style. ++ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change. ++ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```. + +If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas). +You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). + +License +------- +This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). + +See the `NOTICE.txt` file for required notices and attributions. + +Donations +--------- +You like Apache Commons Testing Parent POM? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. + +Additional Resources +-------------------- + ++ [Apache Commons Homepage](https://commons.apache.org/) ++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/TESTING) ++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) ++ `#apache-commons` IRC channel on `irc.freenode.org` + +[ml]:https://commons.apache.org/mail-lists.html http://git-wip-us.apache.org/repos/asf/commons-testing/blob/690fe3f7/src/site/xdoc/index.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index fccee90..5e6aef9 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -1,157 +1,157 @@ -<?xml version="1.0"?> -<!-- - 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. ---> -<document> - <properties> - <title>Home</title> - <author email="d...@commons.apache.org">Commons Documentation Team</author> - </properties> - <body> - <!-- ================================================== --> - <section name="Apache Commons Testing"> - <p> - <em>Apache Commons Testing</em> - is a multi-module project focused on providing code for testing applications - using various testing frameworks with an initial focus on JUnit 4. - </p> - </section> - <!-- ================================================== --> - <section name="Documentation"> - <p> - The package descriptions in the - <a href="javadocs/api-release/index.html">JavaDoc</a> - give an overview of the available features - and various - <a href="project-reports.html">project reports</a> - are provided. - </p> - <p> - The JavaDoc API documents are available online: - </p> - <ul> - <li> - The - <a href="javadocs/api-1.0.0/index.html">current stable release 1.0.0</a> - [Java 7] - </li> - </ul> - <p> - The - <a href="source-repository.html">git repository</a> - can be - <a href="https://git-wip-us.apache.org/repos/asf?p=commons-testing.git";>browsed</a> - , or you can browse/contribute via - <a href="https://github.com/apache/commons-testing";>GitHub</a> - . - </p> - </section> - <!-- ================================================== --> - <section name="Release Information"> - <p>The latest stable release of Lang is 1.0.0. You may: </p> - <ul> - <li> - Download - <a href="http://commons.apache.org/lang/download_lang.cgi";>1.0.0</a> - </li> - <li> - Read the - <a href="RELEASE-NOTES.txt">1.0.0 release notes</a> - </li> - </ul> - <p> - Alternatively you can pull various artifacts it from the central Maven repository: - </p> - <ul> - <li> - <a href="generic/dependency-info.html">Apache Commons Testing Generic</a> - </li> - <li> - <a href="junit4/dependency-info.html">Apache Commons Testing for JUnit 4</a> - </li> - <li> - <a href="junit4-mongodb/dependency-info.html">Apache Commons Testing for JUnit 4 for MongoDB</a> - </li> - </ul> - <p> - For information on previous releases see the - <a href="release-history.html">Release History</a> - , and to download previous releases see the - <a href="http://archive.apache.org/dist/commons/testing/";>Commons Testing Archive</a> - . - </p> - </section> - <!-- ================================================== --> - <section name="Getting Involved"> - <p> - The - <a href="mail-lists.html">commons developer mailing list</a> - is the main channel of communication for contributors. Please remember that the lists are shared between all - commons components, so prefix your email by [testing]. - </p> - <p> - You can also visit the #apache-commons IRC channel on irc.freenode.net or peruse - <a href="issue-tracking.html">JIRA</a> - . Specific links of interest for JIRA are: - </p> - <ul> - <li> - Ideas looking for code: - <a - href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20TESTING%20AND%20resolution%20%3D%20Unresolved%20AND%20fixVersion%20%3D%20%22Patch%20Needed%22%20ORDER%20BY%20priority%20DESC";>Patch Needed</a> - </li> - <li> - Issues with patches, looking for reviews: - <a - href="https://issues.apache.org/jira/issues/?jql=fixVersion%20%3D%20%22Review%20Patch%22%20AND%20project%20%3D%20TESTING%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20priority%20DESC";>Review Patch</a> - </li> - </ul> - <p> - Alternatively you can go through the - <em>Needs Work</em> - tags in the - <a href="taglist.html">TagList report</a> - . - </p> - <p> - If you'd like to offer up pull requests via GitHub rather than applying patches to JIRA, we have a - <a href="https://github.com/apache/commons-testing/";>GitHub mirror</a> - . - </p> - </section> - <!-- ================================================== --> - <section name="Support"> - <p> - The - <a href="mail-lists.html">commons mailing lists</a> - act as the main support forum. - The user list is suitable for most library usage queries. - The dev list is intended - for the development discussion. - Please remember that the lists are shared between all commons components, - so - prefix your email by [testing]. - </p> - <p> - Bug reports and enhancements are also welcomed via the - <a href="issue-tracking.html">JIRA</a> - issue tracker. - Please read the instructions carefully. - </p> - </section> - <!-- ================================================== --> - </body> -</document> +<?xml version="1.0"?> +<!-- + 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. +--> +<document> + <properties> + <title>Home</title> + <author email="d...@commons.apache.org">Commons Documentation Team</author> + </properties> + <body> + <!-- ================================================== --> + <section name="Apache Commons Testing"> + <p> + <em>Apache Commons Testing</em> + is a multi-module project focused on providing code for testing applications + using various testing frameworks with an initial focus on JUnit 4. + </p> + </section> + <!-- ================================================== --> + <section name="Documentation"> + <p> + The package descriptions in the + <a href="javadocs/api-release/index.html">Javadoc</a> + give an overview of the available features + and various + <a href="project-reports.html">project reports</a> + are provided. + </p> + <p> + The Javadoc API documents are available online: + </p> + <ul> + <li> + The + <a href="javadocs/api-1.0.0/index.html">current stable release 1.0.0</a> + [Java 7] + </li> + </ul> + <p> + The + <a href="source-repository.html">git repository</a> + can be + <a href="https://git-wip-us.apache.org/repos/asf?p=commons-testing.git";>browsed</a> + , or you can browse/contribute via + <a href="https://github.com/apache/commons-testing";>GitHub</a> + . + </p> + </section> + <!-- ================================================== --> + <section name="Release Information"> + <p>The latest stable release of Lang is 1.0.0. You may: </p> + <ul> + <li> + Download + <a href="http://commons.apache.org/lang/download_lang.cgi";>1.0.0</a> + </li> + <li> + Read the + <a href="RELEASE-NOTES.txt">1.0.0 release notes</a> + </li> + </ul> + <p> + Alternatively you can pull various artifacts it from the central Maven repository: + </p> + <ul> + <li> + <a href="generic/dependency-info.html">Apache Commons Testing Generic</a> + </li> + <li> + <a href="junit4/dependency-info.html">Apache Commons Testing for JUnit 4</a> + </li> + <li> + <a href="junit4-mongodb/dependency-info.html">Apache Commons Testing for JUnit 4 for MongoDB</a> + </li> + </ul> + <p> + For information on previous releases see the + <a href="release-history.html">Release History</a> + , and to download previous releases see the + <a href="http://archive.apache.org/dist/commons/testing/";>Commons Testing Archive</a> + . + </p> + </section> + <!-- ================================================== --> + <section name="Getting Involved"> + <p> + The + <a href="mail-lists.html">commons developer mailing list</a> + is the main channel of communication for contributors. Please remember that the lists are shared between all + commons components, so prefix your email by [testing]. + </p> + <p> + You can also visit the #apache-commons IRC channel on irc.freenode.net or peruse + <a href="issue-tracking.html">JIRA</a> + . Specific links of interest for JIRA are: + </p> + <ul> + <li> + Ideas looking for code: + <a + href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20TESTING%20AND%20resolution%20%3D%20Unresolved%20AND%20fixVersion%20%3D%20%22Patch%20Needed%22%20ORDER%20BY%20priority%20DESC";>Patch Needed</a> + </li> + <li> + Issues with patches, looking for reviews: + <a + href="https://issues.apache.org/jira/issues/?jql=fixVersion%20%3D%20%22Review%20Patch%22%20AND%20project%20%3D%20TESTING%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20priority%20DESC";>Review Patch</a> + </li> + </ul> + <p> + Alternatively you can go through the + <em>Needs Work</em> + tags in the + <a href="taglist.html">TagList report</a> + . + </p> + <p> + If you'd like to offer up pull requests via GitHub rather than applying patches to JIRA, we have a + <a href="https://github.com/apache/commons-testing/";>GitHub mirror</a> + . + </p> + </section> + <!-- ================================================== --> + <section name="Support"> + <p> + The + <a href="mail-lists.html">commons mailing lists</a> + act as the main support forum. + The user list is suitable for most library usage queries. + The dev list is intended + for the development discussion. + Please remember that the lists are shared between all commons components, + so + prefix your email by [testing]. + </p> + <p> + Bug reports and enhancements are also welcomed via the + <a href="issue-tracking.html">JIRA</a> + issue tracker. + Please read the instructions carefully. + </p> + </section> + <!-- ================================================== --> + </body> +</document>
