This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/poi.git
The following commit(s) were added to refs/heads/trunk by this push:
new 9b7938bf81 update docs
9b7938bf81 is described below
commit 9b7938bf81c97105af0ba031c06c446ceb1697aa
Author: PJ Fanning <[email protected]>
AuthorDate: Tue Nov 18 23:55:40 2025 +0100
update docs
---
src/documentation/content/xdocs/apidocs/index.xml | 8 ++-
src/documentation/content/xdocs/changes.xml | 6 +-
src/documentation/content/xdocs/security.xml | 12 +++-
src/documentation/content/xdocs/versioning.xml | 76 ++++++++++++++++-------
4 files changed, 76 insertions(+), 26 deletions(-)
diff --git a/src/documentation/content/xdocs/apidocs/index.xml
b/src/documentation/content/xdocs/apidocs/index.xml
index 8266786b10..f3759e956e 100644
--- a/src/documentation/content/xdocs/apidocs/index.xml
+++ b/src/documentation/content/xdocs/apidocs/index.xml
@@ -33,9 +33,7 @@
The Javadocs for the latest (development) version of Apache POI
can be <a href="dev/index.html">accessed online here</a>, or build
from a <a href="site:git">source code checkout</a>
- by running the <em>javadocs</em> Ant task. The
- <a href="dev/index.html">latest (development) Javadocs</a> are generally
- updated every few weeks, so may lag the most recent development slightly.
+ by running the <em>javadocs</em> Gradle task.
</p>
<p>
For recent releases, the Javadocs for the latest stable release
@@ -47,6 +45,10 @@
<li><a href="ext:apidocs/v40">Apache POI 4.0.x Javadocs</a></li>
<li><a href="ext:apidocs/v317">Apache POI 3.17 Javadocs</a></li>
</ul>
+ <p>
+ <a href="https://javadoc.io/doc/org.apache.poi";>Javadoc.io</a> is
+ probably the best resource for browsing Apache POI Javadocs.
+ </p>
<section><title>Older Releases</title>
<p>
diff --git a/src/documentation/content/xdocs/changes.xml
b/src/documentation/content/xdocs/changes.xml
index a6f8ffd818..b535fbb29f 100644
--- a/src/documentation/content/xdocs/changes.xml
+++ b/src/documentation/content/xdocs/changes.xml
@@ -71,8 +71,12 @@
</section>
<release version="5.5.1" date="2025-12-??">
+ <summary>
+ <summary-item>Upgrade commons-io dependency to
2.21.0</summary-item>
+ <summary-item>Upgrade pdfbox dependency to 3.0.6</summary-item>
+ </summary>
<actions>
- <action type="fix" fixes-bug="github-932" context="POI_Overall">Add
back module-info classes that were omitted from the 5.5.0 jars by
accident</action>
+ <action type="fix" fixes-bug="github-932"
context="POI_Overall">Add back module-info classes that were omitted from the
5.5.0 jars by accident</action>
</actions>
</release>
diff --git a/src/documentation/content/xdocs/security.xml
b/src/documentation/content/xdocs/security.xml
index a902f05a8a..379adcb8a4 100644
--- a/src/documentation/content/xdocs/security.xml
+++ b/src/documentation/content/xdocs/security.xml
@@ -32,7 +32,7 @@
<section>
<title>Overview</title>
- <p>This page provides some guidance about how Apache POI can be used
in security-sensible areas.</p>
+ <p>This page provides some guidance about how Apache POI can be used
in security-sensitive areas.</p>
</section>
<section>
@@ -99,6 +99,16 @@
inputs, even if they are not explicitly security-related.
<br />
</li>
+ <li><strong>Monitor security advisories</strong><br/>
+ Keep an eye on security advisories related to Apache POI. You
can find them on the
+ <a href="https://poi.apache.org";>POI website</a> and they are
shared on the
+ <a href="https://poi.apache.org/help/index.html";>POI mailing
lists</a> as well as
+ the <a
href="https://lists.apache.org/[email protected]";>Apache Announce
Mailing List</a>.
+ <br />
+ <a
href="https://app.opencve.io/cve/?product=poi&vendor=apache";>OpenCVE</a> is
one of a
+ number of services that can help you monitor CVEs for specific
products.
+ <br />
+ </li>
</ul>
</section>
</body>
diff --git a/src/documentation/content/xdocs/versioning.xml
b/src/documentation/content/xdocs/versioning.xml
index 195b48c381..84fa7145a7 100644
--- a/src/documentation/content/xdocs/versioning.xml
+++ b/src/documentation/content/xdocs/versioning.xml
@@ -29,27 +29,61 @@
<body>
<section><title>Versioning</title>
-<p>
- Apache POI™ releases are available under the <a
href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version
2.0.</a>
- from the <a href="site:download">Download</a> page.
-</p>
-<p>
- The versioning scheme for Apache POI is based on the principles of
- <a href="https://semver.org/";>Semantic Versioning 2.0.0</a>.
-</p>
-<p>
- We started using this versioning scheme in Apache POI 4.0.0. Versions prior
- to this did not follow exactly the same principles with the numbers
typically being of the form
- X.Y. X indicated the major version but there may in some cases, have been
big changes between
- minor versions.
-</p>
-<p>
- We typically only release new versions and don't usually patch old releases.
- We may consider patching old releases in exceptional circumstances.
- It is recommended to always use the latest version of Apache POI.
-</p>
-</section>
-</body>
+ <p>
+ Apache POI™ releases are available under the <a
href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version
2.0.</a>
+ from the <a href="site:download">Download</a> page.
+ </p>
+ <p>
+ The versioning scheme for Apache POI is based on the principles of
+ <a href="https://semver.org/";>Semantic Versioning 2.0.0</a>.
+ </p>
+ <p>
+ We started using this versioning scheme in Apache POI 4.0.0. Versions
prior
+ to this did not follow exactly the same principles with the numbers
typically being of the form
+ X.Y. X indicated the major version but there may in some cases, have
been big changes between
+ minor versions.
+ </p>
+ <p>
+ We typically only release new versions and don't usually patch old
releases.
+ We may consider patching old releases in exceptional circumstances.
+ It is recommended to always use the latest version of Apache POI.
+ </p>
+ </section>
+ <section><title>Migrating from older versions</title>
+ <p>
+ Typically, migrating from one major version to the next should be
straightforward.
+ Before migrating, you should check if you are using any deprecated
APIs and try to update
+ your code by following the deprecation notices.
+ </p>
+ <p>
+ If you are migrating across multiple major versions, it is recommended
to do this
+ step by step, i.e. first migrate to the next major version, test your
application
+ and then continue to the next major version. A method might have been
deprecated
+ in one major version and then removed in the next major version.
+ </p>
+ <p>
+ Minor versions may introduce new features and deprecate existing APIs.
+ They might also contain bug fixes that could potentially affect
existing functionality.
+ </p>
+ <p>
+ POI 5.0.0 renamed the ooxml-schemas jar to poi-ooxml-full and
+ poi-ooxml-schemas jar to poi-ooxml-lite. Please check your dependencies
+ when migrating from POI 4.x to POI 5.x.
+ </p>
+ <p>
+ Please check the <a href="changes.html">Change Log</a> for details
about
+ what has changed in each version.
+ </p>
+ <p>
+ The <a href="https://poi.apache.org/help/faq.html";>FAQ</a> may also
contain
+ useful information.
+ </p>
+ <p>
+ If you encounter any issues when migrating, please report them to the
+ <a href="https://poi.apache.org/help/index.html";>mailing list</a>.
+ </p>
+ </section>
+ </body>
<footer>
<legal>
Copyright (c) @year@ The Apache Software Foundation All rights reserved.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
