TENTACLES-16: Try to add more site elements and download page
diff --git a/pom.xml b/pom.xml
index 1ebc979..34e04c3 100644
--- a/pom.xml
+++ b/pom.xml
@@ -82,6 +82,9 @@
</dependency>
</dependencies>
<properties>
+ <!-- needs to be adapted during release in order to properly generate download pages -->
+ <currentSnapshotTentaclesVersion>0.2-SNAPSHOT</currentSnapshotTentaclesVersion>
+ <previousTentaclesVersion>0.1</previousTentaclesVersion>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<javaVersion>1.8</javaVersion>
<httpClientVersion>4.5.13</httpClientVersion>
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
new file mode 100644
index 0000000..3cf3b6f
--- /dev/null
+++ b/src/site/apt/index.apt.vm
@@ -0,0 +1,117 @@
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~ 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.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ --------------------------
+ Introduction
+ --------------------------
+
+About Apache Tentacles™
+
+https://maven.apache.org/doxia/references/apt-format.html
+
+TBD: Copy over from current site! Rat audits software distributions, with a special interest in headers.
+ If this isn't quite what you're looking for then take a look at the
+ other products developed by {{{https://creadur.apache.org}Apache Creadur}}™,
+ including {{{https://creadur.apache.org/whisker}Apache Whisker}}™ which audits
+ and generates legal (for example <<<LICENSE>>>) documents for
+ complex software distributions.
+
+* Running from the Command Line
+
+ Run from the command line with:
+
++------------------------------------------+
+java -jar apache-rat/target/apache-rat-${project.version}.jar --help
++------------------------------------------+
+
+ This will output a help message detailing the command line
+ options available to you.
+
+* Adding license headers
+
+ Rat can be used to automatically add license headers to
+ files that do not currently have them. Only files that
+ are not excluded by the Rat configurations will be affected.
+
+ To add license headers use a command such as:
+
++------------------------------------------+
+java -jar apache-rat/target/apache-rat-${project.version}.jar --addlicense
+ --copyright "Copyright 2008 Foo" --force
+ /path/to/project
++------------------------------------------+
+
+ This command will add the license header directly to the
+ source files. If you prefer to see which files will be
+ changed and how then remove the "--force" option.
+
+* Using multiple excludes from a file
+
+ It is common to use the Rat with the Maven or Ant plugins and specify
+ a series of files to exclude (such as a README or version control
+ files). If you are using the Rat application instead of a plugin you
+ can specify a series of regex excludes in a file and specify that with
+ the -E option.
+
++------------------------------------------+
+java -jar apache-rat/target/apache-rat-${project.version}.jar
+ -E /path/to/project/.rat-excludes
+ -d /path/to/project
++------------------------------------------+
+
+* Command Line Options
+
+
++------------------------------------------+
+usage: java -jar apache-rat/target/apache-rat-${project.version}.jar
+ [options] [DIR|TARBALL]
+
+Available options
+ -A,--addLicense Add the default license header to any file
+ with an unknown license that is not in the
+ exclusion list. By default new files will
+ be created with the license header, to
+ force the modification of existing files
+ use the --force option.
+ -a,--addlicense Add the default license header to any file
+ with an unknown license that is not in the
+ exclusion list. By default new files will
+ be created with the license header, to
+ force the modification of existing files
+ use the --force option.
+ -c,--copyright <arg> The copyright message to use in the
+ license headers, usually in the form of
+ "Copyright 2008 Foo"
+ -d,--dir Used to indicate source when using
+ --exclude
+ -E,--exclude-file <fileName> Excludes files matching regular expression
+ in <file> Note that --dir is required when
+ using this parameter.
+ -e,--exclude <expression> Excludes files matching wildcard
+ <expression>. Note that --dir is required
+ when using this parameter. Allows multiple
+ arguments.
+ -f,--force Forces any changes in files to be written
+ directly to the source files (i.e. new
+ files are not created)
+ -h,--help Print help for the Rat command line
+ interface and exit
+ -s,--stylesheet <arg> XSLT stylesheet to use when creating the
+ report. Not compatible with -x
+ -x,--xml Output the report in raw XML format. Not
+ compatible with -s
++------------------------------------------+
diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css
new file mode 100644
index 0000000..3683f87
--- /dev/null
+++ b/src/site/resources/css/site.css
@@ -0,0 +1,27 @@
+/*
+ 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.
+*/
+footer {
+ font-family: "Mate SC", "Lucida Console", Monaco, monospace;
+ font-size: 9pt;
+ padding: 5px 10px;
+ text-align: justify;
+ border: thin solid #D0D0D0;
+ background-color: #F8F8F8;
+ color: #404040;
+}
\ No newline at end of file
diff --git a/src/site/resources/download_tentacles.cgi b/src/site/resources/download_tentacles.cgi
new file mode 100755
index 0000000..4324f76
--- /dev/null
+++ b/src/site/resources/download_tentacles.cgi
@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# 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.
+
+# Wrapper script around mirrors.cgi script
+# (we must change to that directory in order for python to pick up the
+# python includes correctly)
+cd /www/www.apache.org/dyn/mirrors
+/www/www.apache.org/dyn/mirrors/mirrors.cgi $*
diff --git a/src/site/site.xml b/src/site/site.xml
index ccb214d..4872430 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -1,4 +1,4 @@
-<project name="apache-tentacles">
+<?xml version="1.0" ?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,62 +15,92 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
+<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 http://maven.apache.org/xsd/decoration-1.3.0.xsd"
+ name="Apache Tentacles&trade;">
+ <bannerLeft>
+ <title>The Apache Software Foundation</title>
+ <name>The Apache Software Foundation</name>
+ <src>https://www.apache.org/img/asf_logo.png</src>
+ <href>https://www.apache.org/</href>
+ </bannerLeft>
- <skin>
- <groupId>org.apache.maven.skins</groupId>
- <artifactId>maven-fluido-skin</artifactId>
- </skin>
+ <poweredBy>
+ <logo name="Maven"
+ href="https://maven.apache.org/"
+ img="https://maven.apache.org/images/logos/maven-feather.png"/>
- <custom>
- <fluidoSkin>
-<googleSearch>
- <sitesearch/>
- </googleSearch>
- <topBarEnabled>true</topBarEnabled>
- <sideBarEnabled>true</sideBarEnabled>
- </fluidoSkin>
- </custom>
+ </poweredBy>
-<body>
+ <body>
+ <head>
+ <![CDATA[<link href="https://fonts.googleapis.com/css?family=Mate+SC" type="text/css" rel="stylesheet" />]]>
+ </head>
+
+ <breadcrumbs>
+ <item name="Apache" href="https://www.apache.org/"/>
+ <item name="Creadur" href="https://creadur.apache.org/"/>
+ <item name="Tentacles" href="https://creadur.apache.org/tentacles/"/>
+ </breadcrumbs>
+
+ <menu name="Apache Tentacles™" inherit="bottom">
+ <item name="Introducing Tentacles" href="/index.html"/>
+ <item name="Javadocs" href="/apidocs/index.html"/>
+ <item name="Downloads" href="/download_tentacles.cgi"/>
+ <item name="Changes" href="/RELEASE_NOTES.txt"/>
+ </menu>
+
+ <menu name="Running Tentacles" inherit="bottom">
+ <item name="tbd: From The Command Line" href="apache-rat/index.html"/>
+ </menu>
+
+ <menu name="Apache Creadur™" inherit="bottom">
+ <item name='Creadur Project Home' href="https://creadur.apache.org"/>
+ <item name='Apache Tentacles' href="https://creadur.apache.org/tentacles"/>
+ <item name='Apache Whisker' href="https://creadur.apache.org/whisker"/>
+ <item name='Security' href='https://www.apache.org/security/'/>
+ <item name='License' href='https://www.apache.org/licenses/'/>
+ <item name='Sponsorship' href='https://www.apache.org/foundation/sponsorship.html'/>
+ <item name='Thanks' href='https://www.apache.org/foundation/thanks.html'/>
+ </menu>
+
<menu name="The Apache Software Foundation" inherit="bottom">
<item name='About the Foundation'
- href="http://www.apache.org/foundation"/>
+ href="https://www.apache.org/foundation"/>
<item name='The projects'
- href="http://projects.apache.org"/>
+ href="https://projects.apache.org"/>
<item name='The people'
- href="http://people.apache.org"/>
+ href="https://people.apache.org"/>
<item name='How we work'
- href='http://www.apache.org/foundation/how-it-works.html'/>
+ href='https://www.apache.org/foundation/how-it-works.html'/>
<item name='Our history'
- href='http://www.apache.org/foundation/how-it-works.html#history'/>
+ href='https://www.apache.org/foundation/how-it-works.html#history'/>
<item name='News'
- href='http://blogs.apache.org/foundation/'/>
+ href='https://blogs.apache.org/foundation/'/>
</menu>
<menu name="Contribute" inherit="bottom">
- <item name="Get Involved" href='http://www.apache.org/foundation/getinvolved.html'/>
+ <item name="Get Involved" href='https://www.apache.org/foundation/getinvolved.html'/>
</menu>
<menu name="Committer Info" inherit="bottom">
- <item name="Publish this site" href="site-publish.html"/>
- <item name="Committers' FAQ" href='http://www.apache.org/dev/committers.html'/>
- <item name='New Committers Guide' href='http://www.apache.org/dev/new-committers-guide.html'/>
- <item name='Plant Apache' href='http://planet.apache.org/committers/'/>
- <item name='Community' href='http://community.apache.org/'/>
- <item name='Legal' href='http://www.apache.org/legal/'/>
- <item name='Branding' href='http://www.apache.org/foundation/marks/'/>
- <item name='Media Relations' href='http://www.apache.org/press/'/>
+ <item name="ASF Committers' FAQ" href='https://www.apache.org/dev/committers.html'/>
+ <item name='New Committers Guide' href='https://www.apache.org/dev/new-committers-guide.html'/>
+ <item name="Howto publish this site" href="site-publish.html"/>
+ <item name='Plant Apache' href='https://planet.apache.org/committers/'/>
+ <item name='Community' href='https://community.apache.org/'/>
+ <item name='Legal' href='https://www.apache.org/legal/'/>
+ <item name='Branding' href='https://www.apache.org/foundation/marks/'/>
+ <item name='Media Relations' href='https://www.apache.org/press/'/>
</menu>
<menu ref="modules"/>
<menu ref="reports"/>
- <footer>Copyright © 2014 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
+ <footer>Copyright &copy; 2014-2022 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache Creadur, Creadur, Apache Rat, Apache Tentacles, Apache Whisker, Apache and the Apache feather logo are trademarks
of The Apache Software Foundation.
Oracle and Java are registered trademarks of Oracle and/or its affiliates.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.</footer>
-
-</body>
-
+ </body>
</project>
diff --git a/src/site/xdoc/download_tentacles.xml.vm b/src/site/xdoc/download_tentacles.xml.vm
new file mode 100644
index 0000000..cf45a68
--- /dev/null
+++ b/src/site/xdoc/download_tentacles.xml.vm
@@ -0,0 +1,173 @@
+<?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>Downloads</title>
+ </properties>
+ <body>
+ <section name="Download ${project.name}">
+ <subsection name="Using a Mirror">
+ <p>
+ We recommend you use a mirror to download our release
+ builds, but you <strong>must</strong> <a href="https://www.apache.org/info/verification.html">verify the integrity</a> of
+ the downloaded files using signatures downloaded from our main
+ distribution directories. Recent releases (48 hours) may not yet
+ be available from the mirrors.
+ </p>
+ <p>
+ You are currently using <b>[preferred]</b>. If you
+ encounter a problem with this mirror, please select another
+ mirror. If all mirrors are failing, there are <i>backup</i>
+ mirrors (at the end of the mirrors list) that should be
+ available.
+ <br/>
+ [if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"/></a>[end]
+ </p>
+ <form action="[location]" method="get" id="SelectMirror">
+ <p>
+ Other mirrors:
+ <select name="Preferred">
+ [if-any http]
+ [for http]<option value="[http]">[http]</option>[end]
+ [end]
+ [if-any ftp]
+ [for ftp]<option value="[ftp]">[ftp]</option>[end]
+ [end]
+ [if-any backup]
+ [for backup]<option value="[backup]">[backup] (backup)</option>[end]
+ [end]
+ </select>
+ <input type="submit" value="Change"/>
+ </p>
+ </form>
+ <p>
+ The <a href="https://www.apache.org/dist/creadur/KEYS">KEYS</a>
+ file links to the code signing keys used to sign the
+ product. The <code>PGP</code> link downloads the OpenPGP
+ compatible signature from our main site. The
+ <code>SHA512</code> links download the checksum from the main site.
+ </p>
+ </subsection>
+ </section>
+ <section name="Latest release of ${project.name} is ${previousTentaclesVersion}">
+ <subsection name="Binaries">
+ <table>
+ <tr>
+ <td>
+ <a href="[preferred]/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-bin.tar.bz2">apache-rat-${previousTentaclesVersion}-bin.tar.bz2</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-bin.tar.bz2.sha512">sha512</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-bin.tar.bz2.asc">pgp</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="[preferred]/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-bin.tar.gz">apache-tentacles-${previousTentaclesVersion}-bin.tar.gz</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-bin.tar.gz.sha512">sha512</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-bin.tar.gz.asc">pgp</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="[preferred]/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-bin.zip">apache-tentacles-${previousTentaclesVersion}-bin.zip</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-bin.zip.sha512">sha512</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-bin.zip.asc">pgp</a>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Source">
+ <table>
+ <tr>
+ <td>
+ <a href="[preferred]/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-src.tar.bz2">apache-tentacles-${previousTentaclesVersion}-src.tar.bz2</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-src.tar.bz2.sha512">sha512</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-src.tar.bz2.asc">pgp</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="[preferred]/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-src.tar.gz">apache-tentacles-${previousTentaclesVersion}-src.tar.gz</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-src.tar.gz.sha512">sha512</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-src.tar.gz.asc">pgp</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="[preferred]/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-src.zip">apache-tentacles-${previousTentaclesVersion}-src.zip</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-src.zip.sha512">sha512</a>
+ </td>
+ <td>
+ <a href="https://www.apache.org/dist/creadur/apache-tentacles-${previousTentaclesVersion}/apache-tentacles-${previousTentaclesVersion}-src.zip.asc">pgp</a>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ </section>
+ <div class="section">
+ <h2><a name="Apache_Creadur_Tentacles_${currentSnapshotTentaclesVersion}"/>${project.name} ${currentSnapshotTentaclesVersion}</h2>
+ <div class="section">
+ <h3><a name="Snapshots"/>Snapshots</h3>
+ <table border="0" class="bodyTable">
+ <tr class="a">
+ <td colspan="4">
+ <a class="externalLink" href="https://repository.apache.org/content/repositories/snapshots/org/apache/creadur/tentacles/apache-tentacles/">${project.name} ${currentSnapshotTentaclesVersion}</a>
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+ <section name="Archives">
+ <p>
+ Older releases can be obtained from the archives.
+ </p>
+ <ul>
+ <li class="download">
+ <a href="[preferred]/creadur/">browse download area</a>
+ </li>
+ <li>
+ <a href="https://archive.apache.org/dist/creadur/">archives...</a>
+ </li>
+ <li>
+ <a href="https://archive.apache.org/dist/incubator/rat/">Incubator archives...</a>
+ </li>
+ </ul>
+ </section>
+ </body>
+</document>
