Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refresh documentation site #242

Merged
merged 1 commit into from
Mar 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ For publishing the site do the following:

```
cd target/checkout
mvn verify site site:stage scm-publish:publish-scm
mvn verify site
mvn scm-publish:publish-scm
```
5 changes: 3 additions & 2 deletions animal-sniffer-annotations/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,13 @@
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->
<project>
<project xmlns="http://maven.apache.org/DECORATION/1.3.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 https://maven.apache.org/xsd/decoration-1.3.0.xsd">
<body>
<menu ref="parent"/>

<menu name="Overview">
<item name="Introduction" href="index.html"/>
</menu>
<menu ref="reports"/>
</body>
</project>
26 changes: 0 additions & 26 deletions animal-sniffer-ant-tasks/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -92,43 +92,17 @@
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-invoker-plugin</artifactId>
<configuration>
<pomIncludes>
<pomInclude>*/pom.xml</pomInclude>
</pomIncludes>
</configuration>
</plugin>
</plugins>
</build>

<profiles>
<profile>
<!-- run integration tests
to use this profile:
or run integration tests: mvn -Prun-its
-->
<id>run-its</id>
<build>
<defaultGoal>verify</defaultGoal>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-invoker-plugin</artifactId>
<executions>
<execution>
<id>integration-test</id>
<goals>
<goal>install</goal>
<goal>run</goal>
</goals>
<configuration>
<streamLogs>false</streamLogs>
<debug>true</debug>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
Expand Down
8 changes: 4 additions & 4 deletions animal-sniffer-ant-tasks/src/site/apt/index.apt
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,16 @@ Animal Sniffer ANT Tasks
{{{http://docs.codehaus.org/display/MAVENUSER/Animal+Sniffer+ANT+Tasks}ANT Tasks's wiki page}}.

In case you still have questions regarding the ANT Tasks's usage, please feel
free to contact the {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
the {{{./mail-lists.html}mail archive}}.
the {{{./mailing-lists.html}mail archive}}.

If you feel like the ANT Tasks are missing a feature or have a defect, you can fill a feature request or bug report in our
{{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
{{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
entire debug logs, <<<build.xml>>>s or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
{{{./source-repository.html}source repository}} and will find supplementary information in the
{{{./scm.html}source repository}} and will find supplementary information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.

* Examples
Expand Down
6 changes: 4 additions & 2 deletions animal-sniffer-ant-tasks/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,20 @@
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->
<project>
<project xmlns="http://maven.apache.org/DECORATION/1.3.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 https://maven.apache.org/xsd/decoration-1.3.0.xsd">
<body>
<menu ref="parent"/>

<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Usage" href="usage.html"/>
</menu>

<menu name="Examples">
<item name="Checking signatures" href="examples/checking-signatures.html"/>
<item name="Generating signatures" href="examples/generating-signatures.html"/>
<item name="Sample project" href="examples/sample-project.html"/>
</menu>
<menu ref="reports"/>
</body>
</project>
8 changes: 4 additions & 4 deletions animal-sniffer-enforcer-rule/src/site/apt/index.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,16 @@ Animal Sniffer Enforcer Rule
{{{http://docs.codehaus.org/display/MAVENUSER/Animal+Sniffer+Enforcer+Rule}enforcer rule's wiki page}}.

In case you still have questions regarding the enforcer rule's usage, feel free to contact the
{{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
{{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
the {{{./mail-lists.html}mail archive}}.
the {{{./mailing-lists.html}mail archive}}.

If you feel like the enforcer rule is missing a feature or has a defect, you can fill a feature request or bug report
in our {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description
in our {{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description
of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this
reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much
appreciated. Of course, patches are welcome, too. Contributors can check out the project from our
{{{./source-repository.html}source repository}} and will find supplementary information in the
{{{./scm.html}source repository}} and will find supplementary information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.

* Examples
Expand Down
14 changes: 8 additions & 6 deletions animal-sniffer-enforcer-rule/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,18 @@
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->
<project>
<project xmlns="http://maven.apache.org/DECORATION/1.3.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 https://maven.apache.org/xsd/decoration-1.3.0.xsd">
<body>
<menu ref="parent"/>
<menu ref="parent" />

<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Usage" href="usage.html"/>
<item name="Introduction" href="index.html" />
<item name="Usage" href="usage.html" />
</menu>

<menu name="Examples">
<item name="Checking a project against API signatures" href="examples/checking-signatures.html"/>
<item name="Checking a project against API signatures" href="examples/checking-signatures.html" />
</menu>
<menu ref="reports"/>
</body>
</project>
66 changes: 32 additions & 34 deletions animal-sniffer-maven-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -87,54 +87,44 @@
<artifactId>plexus-utils</artifactId>
<version>3.5.1</version>
</dependency>

<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<scope>provided</scope>
</dependency>

</dependencies>

<build>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
<configuration>
<!-- see http://jira.codehaus.org/browse/MNG-5346 -->
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
</configuration>
<executions>
<execution>
<id>mojo-descriptor</id>
<goals>
<goal>descriptor</goal>
</goals>
</execution>
<execution>
<id>help-goal</id>
<goals>
<goal>helpmojo</goal>
</goals>
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-invoker-plugin</artifactId>
<artifactId>maven-plugin-report-plugin</artifactId>
<reportSets>
<reportSet>
<reports>
<report>report</report>
</reports>
</reportSet>
</reportSets>
<configuration>
<filterProperties>
<java.home>${env.JAVA_HOME}</java.home>
</filterProperties>
<extraArtifacts>
<extraArtifact>org.codehaus.mojo:animal-sniffer-annotations:${project.version}</extraArtifact>
</extraArtifacts>
<requirementsHistories>
<history>
<version>1.23</version>
<maven>3.2.5</maven>
<jdk>1.8</jdk>
</history>
<history>
<version>1.22</version>
<maven>2.2.1</maven>
<jdk>1.8</jdk>
</history>
</requirementsHistories>
</configuration>
</plugin>
</plugins>
</build>
</reporting>

<profiles>
<profile>
Expand All @@ -144,6 +134,14 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-invoker-plugin</artifactId>
<configuration>
<filterProperties>
<java.home>${env.JAVA_HOME}</java.home>
</filterProperties>
<extraArtifacts>
<extraArtifact>org.codehaus.mojo:animal-sniffer-annotations:${project.version}</extraArtifact>
</extraArtifacts>
</configuration>
</plugin>
</plugins>
</build>
Expand Down
13 changes: 5 additions & 8 deletions animal-sniffer-maven-plugin/src/site/apt/index.apt
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,19 @@ Animal Sniffer Maven Plugin

* Usage

General instructions on how to use the Animal Sniffer Plugin can be found on the {{{./usage.html}usage page}}. Some more
specific use cases are described in the examples given below. Last but not least, users occasionally contribute
additional examples, tips or errata to the
{{{http://docs.codehaus.org/display/MAVENUSER/Animal+Sniffer+Maven+Plugin}plugin's wiki page}}.
General instructions on how to use the Animal Sniffer Plugin can be found on the {{{./usage.html}usage page}}.

In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
free to contact the {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
the {{{./mail-lists.html}mail archive}}.
the {{{./mailing-lists.html}mail archive}}.

If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
{{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
{{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
{{{./source-repository.html}source repository}} and will find supplementary information in the
{{{./scm.html}source repository}} and will find supplementary information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.

* Examples
Expand Down
17 changes: 8 additions & 9 deletions animal-sniffer-maven-plugin/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,24 @@
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->
<project>
<project xmlns="http://maven.apache.org/DECORATION/1.3.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 https://maven.apache.org/xsd/decoration-1.3.0.xsd">


<body>
<breadcrumbs>
<item name="Animal Sniffer Maven plugin" href="./" />
</breadcrumbs>
<menu name="Parent Project">
<item name="Codehaus Mojo Parent" href="../index.html"/>
<item name="Animal Sniffer Parent project" href="../animal-sniffer/index.html"/>
</menu>

<menu ref="parent"/>

<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Usage" href="usage.html"/>
<item name="Frequently Asked Questions" href="faq.html"/>
</menu>

<menu name="Examples">
<item name="Checking a project against API signatures" href="examples/checking-signatures.html"/>
<item name="Generating signatures of the Java Runtime" href="examples/generating-java-signatures.html"/>
<item name="Generating signatures of other APIs" href="examples/generating-other-api-signatures.html"/>
</menu>
<menu ref="reports"/>
</body>
</project>
8 changes: 4 additions & 4 deletions animal-sniffer/src/site/apt/index.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -67,16 +67,16 @@ Animal Sniffer
{{{http://docs.codehaus.org/display/MAVENUSER/Animal_Sniffer}animal-sniffer's wiki page}}.

In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
free to contact the {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
the {{{./mail-lists.html}mail archive}}.
the {{{./mailing-lists.html}mail archive}}.

If you feel like animal-sniffer is missing a feature or has a defect, you can fill a feature request or bug report in
our {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of
our {{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of
your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this
reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much
appreciated. Of course, patches are welcome, too. Contributors can check out the project from our
{{{./source-repository.html}source repository}} and will find supplementary information in the
{{{./scm.html}source repository}} and will find supplementary information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.

* Examples
Expand Down
7 changes: 5 additions & 2 deletions animal-sniffer/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,13 @@
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->
<project>
<project xmlns="http://maven.apache.org/DECORATION/1.3.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 https://maven.apache.org/xsd/decoration-1.3.0.xsd">
<body>
<menu ref="parent" />

<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Introduction" href="index.html" />
</menu>
</body>
</project>
7 changes: 4 additions & 3 deletions java-boot-classpath-detector/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,13 @@
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->
<project>
<project xmlns="http://maven.apache.org/DECORATION/1.3.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 https://maven.apache.org/xsd/decoration-1.3.0.xsd">
<body>
<menu ref="parent"/>

<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Introduction" href="index.html" />
</menu>
<menu ref="reports"/>
</body>
</project>