You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2022/07/29 07:27:23 UTC
[pdfbox-docs] branch master updated: PDFBOX-5475: update documentation to build website to match new tooling
This is an automated email from the ASF dual-hosted git repository.
msahyoun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pdfbox-docs.git
The following commit(s) were added to refs/heads/master by this push:
new d30e695d PDFBOX-5475: update documentation to build website to match new tooling
d30e695d is described below
commit d30e695d51487953d5384d23a46128c35ab44622
Author: Maruan Sahyoun <sa...@fileaffairs.de>
AuthorDate: Fri Jul 29 09:27:03 2022 +0200
PDFBOX-5475: update documentation to build website to match new tooling
---
content/siteupdate.md | 16 +++++-----------
1 file changed, 5 insertions(+), 11 deletions(-)
diff --git a/content/siteupdate.md b/content/siteupdate.md
index a9ab5103..6c6d9b0b 100644
--- a/content/siteupdate.md
+++ b/content/siteupdate.md
@@ -136,19 +136,13 @@ mvn scm-publish:publish-scm
This will checkout the current content into the ``./target``directory, apply the changes from ``./staging`` and publish
the changes to the PDFBox production website.
-### Update the JavaDocs for PDFBox 2.x
-To publish the javadocs follow these steps:
+### Update the Javadoc for PDFBox
+The Javadoc for PDFBox is hosted on [javadoc.io](https://javadoc.io/) which uses the `pdfbox-<version>-javadoc.jar` built at release time as a source. javadoc.io also makes older versions of the Javadoc available.
-Run
-~~~
- $ mvn clean javadoc:aggregate scm-publish:publish-scm
-~~~
-
-from the `<SVN_ROOT>/../pdfbox` directory.
-
-It uses the same `pdfbox-site` settings from above to connect to the repository.
+In order to update the documentation to match a latest release of a branch
-<p class="alert alert-info">As <code>mvn clean</code> will delete the javadoc files download from the Apache CMS it's advised to configure <code>${svn.scmJavadocCheckoutDirectory}</code> to a local directory not below <code>./target</code>.</p>
+- update the `release` variable in the matching subdirectories `<version>.11tydata.js` file
+- update the link(s) in the `_layouts\documentation.html` file
## Build with Maven