You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/12/16 16:04:54 UTC
(commons-email) 01/03: Update site for next release
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-email.git
commit 1e68064e5349342c8d03037c40a7b0e8c541e150
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Dec 16 09:30:52 2023 -0500
Update site for next release
---
src/site/site.xml | 41 ++++++++++-----------
src/site/xdoc/building.xml | 89 ++++++++++++++++++++++++----------------------
src/site/xdoc/index.xml | 17 +++------
3 files changed, 69 insertions(+), 78 deletions(-)
diff --git a/src/site/site.xml b/src/site/site.xml
index 4e93039..b03e46c 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -16,29 +16,26 @@
limitations under the License.
-->
<project name="Commons Email">
- <bannerRight>
- <name>Commons Email</name>
- <src>/images/email-logo-white.png</src>
- <href>/index.html</href>
- </bannerRight>
+ <bannerRight>
+ <name>Commons Email</name>
+ <src>/images/email-logo-white.png</src>
+ <href>/index.html</href>
+ </bannerRight>
- <body>
- <menu name="Email">
- <item name="Overview" href="/index.html"/>
- <item name="Download" href="https://commons.apache.org/email/download_email.cgi"/>
- <item name="User guide" href="/userguide.html"/>
- <item name="Security Reports" href="/security-reports.html"/>
- <item name="Latest API docs (development)" href="/apidocs/index.html"/>
- <item name="Javadoc (1.5 release)" href="/javadocs/api-release/index.html"/>
- <item name="Javadoc (1.4 release)" href="/javadocs/api-1.4/index.html"/>
- <item name="Javadoc (1.3.3 release)" href="/javadocs/api-1.3.3/index.html"/>
- <item name="Javadoc (1.2 release)" href="/javadocs/api-1.2/index.html"/>
- </menu>
-
- <menu name="Development">
- <item name="Building" href="/building.html"/>
- </menu>
+ <body>
+ <menu name="Email">
+ <item name="Overview" href="/index.html" />
+ <item name="Download" href="https://commons.apache.org/email/download_email.cgi" />
+ <item name="User guide" href="/userguide.html" />
+ <item name="Security Reports" href="/security-reports.html" />
+ <item name="Javadoc" href="/apidocs/index.html" />
+ <item name="Javadoc Archive" href="https://javadoc.io/doc/org.apache.commons/commons-email/latest/index.html" />
+ </menu>
- </body>
+ <menu name="Development">
+ <item name="Building" href="/building.html" />
+ </menu>
+
+ </body>
</project>
diff --git a/src/site/xdoc/building.xml b/src/site/xdoc/building.xml
index d8969e3..2a22e3c 100644
--- a/src/site/xdoc/building.xml
+++ b/src/site/xdoc/building.xml
@@ -16,47 +16,50 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
- <properties>
- <title>Building</title>
- <author email="dev@commons.apache.org">Commons Documentation Team</author>
- </properties>
-<body>
-<!-- ================================================== -->
-<section name="Overview">
-<p>
- Commons Email uses <a href="http://maven.apache.org">Maven 2.0</a>
-</p>
-</section>
-<!-- ================================================== -->
-<section name="Maven Goals">
- <p>
- To build a jar file, change into Email's root directory and run "mvn package".
- The result will be in the "target" subdirectory.
- </p>
- <p>
- To build the Javadocs, run "mvn javadoc:javadoc".
- The result will be in "target/docs/apidocs".
- </p>
- <p>
- To build the full website, run "mvn site".
- The result will be in "target/site".
- You must be using JDK 5 or higher to successfully complete this target.
- </p>
-</section>
-<!-- ================================================== -->
-<section name="Development">
- <p>
- Commons Email may be used on any JRE from 1.5 onwards.
- </p>
- <p>
- Commons Email requires <a href="http://code.google.com/p/subethasmtp/">SubEtha SMTP</a>
- for its unit tests. <br />
- </p>
- <p>
- This jar will be automatically installed to your local Maven 2 repository
- if you build using Maven.
- </p>
-</section>
-<!-- ================================================== -->
-</body>
+ <properties>
+ <title>Building</title>
+ <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+ <body>
+ <section name="Overview">
+ <p>
+ Commons Email uses
+ <a href="http://maven.apache.org">Maven</a>.
+ </p>
+ </section>
+ <section name="Maven Goals">
+ <p>
+ To build a jar and verify all files, change into Email's root directory and run <code>mvn</code>.
+ The result will be in the "target" subdirectory.
+ </p>
+ <p>
+ To only build the jar file, change into Email's root directory and run <code>mvn clean package</code>.
+ The result will be in the "target" subdirectory.
+ </p>
+ <p>
+ To only build the Javadocs, run "mvn clean javadoc:javadoc".
+ The result will be in "target/docs/apidocs".
+ </p>
+ <p>
+ To build the full website, run "mvn clean verify site".
+ The result will be in "target/site".
+ You must be using JDK 5 or higher to successfully complete this target.
+ </p>
+ </section>
+ <section name="Development">
+ <p>
+ Commons Email requires Java 8.
+ </p>
+ <p>
+ Commons Email requires
+ <a href="http://code.google.com/p/subethasmtp/">SubEtha SMTP</a>
+ for its unit tests.
+ <br />
+ </p>
+ <p>
+ This jar will be automatically installed to your local Maven repository
+ if you build using <code>mvn clean install</code>.
+ </p>
+ </section>
+ </body>
</document>
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 54d31cc..dfa7789 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -77,24 +77,15 @@
</p>
<ul>
<li>The
- <a href="javadocs/api-release/index.html">current release 1.5</a>
+ <a href="/apidocs/index.html">Javadoc</a>
</li>
<li>The
- <a href="javadocs/api-1.4/index.html">previous version 1.4</a>
- </li>
- <li>The
- <a href="javadocs/api-1.3.3/index.html">previous version 1.3.3</a>
- </li>
- <li>The
- <a href="javadocs/api-1.2/index.html">previous version 1.2</a>
- </li>
- <li>The
- <a href="apidocs/index.html">latest SVN</a>
+ <a href="https://javadoc.io/doc/org.apache.commons/commons-email/latest/index.html">Javadoc Archive</a>
</li>
</ul>
<p>
The
- <a href="scm.html">subversion repository</a>
+ <a href="scm.html">git repository</a>
can be
<a href="https://gitbox.apache.org/repos/asf?p=commons-email.git">browsed</a>.
</p>
@@ -102,7 +93,7 @@
<!-- ================================================== -->
<section name="Releases">
<p>
- The latest version 1.5, requires Java 6 -
+ The latest version requires Java 8 -
<a href="https://commons.apache.org/email/download_email.cgi">Download now!</a>
<br/>
The full