This is an automated email from the ASF dual-hosted git repository.
mbo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/db-jdo-site.git
The following commit(s) were added to refs/heads/master by this push:
new 936744d JDO-779: update documentation of db-jdo-site to describe how
to generate javadoc in the jdo project and copy the javadoc into the db-jdo-site
936744d is described below
commit 936744d3b1ca04c0685b17af2c0e3962b45ad258
Author: Michael Bouschen <[email protected]>
AuthorDate: Wed May 13 21:05:23 2020 +0200
JDO-779: update documentation of db-jdo-site to describe how to generate
javadoc in the jdo project and copy the javadoc into the db-jdo-site
---
README.md | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 8522217..34011cc 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,15 @@ How to build the website:
* Go to Github.com and create a PR for your branch
* Once the PR is accepted, the changes should be visible on the website (you
may have to refresh the browser).
-
+How to add javadoc
+* Create the javadoc jar (e.g. jdo-api-3.2-javadoc.jar) in the db-jdo
repository by calling `mvn clean install -Papache-release` in the api submodule.
+* Create a new folder under docs e.g. docs/api32.
+* Copy the javadocs jar info the new folder: e.g. `cp jdo-api-3.2-javadoc.jar
docs/api32`.
+* Create a new subforder docs/api32/jdo-api-3.2-javadoc
+* Unpack the javadoc jar in the subfolder
+* Edit javadoc.adoc under src/main/asciidoc and create a new section 'JDO 3.2
javadoc'.
+* Add two links: one referring index.html in the subfolder and one referring
the javadoc jar.
+
### TODO Documentation
* General -> Downloads: Link to release-3.1? Add section about previous
releases, 3.0.1 etc?
* JDO Implementation -> Specification: Where do we host the PDF files?
