Index: oak-parent/pom.xml IDEA additional info: Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP <+>UTF-8 =================================================================== --- oak-parent/pom.xml (revision 69728f1ff4c066f7773eb4f99c11bf77f2d2075e) +++ oak-parent/pom.xml (revision ) @@ -528,30 +528,6 @@ - site-with-javadoc - - - - org.apache.maven.plugins - maven-javadoc-plugin - - - aggregate - - aggregate - - site - - - - ${basedir}/oak-doc/target/site - -notimestamp - - - - - - rdb-mysql Index: pom.xml IDEA additional info: Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP <+>UTF-8 =================================================================== --- pom.xml (revision 69728f1ff4c066f7773eb4f99c11bf77f2d2075e) +++ pom.xml (revision ) @@ -100,6 +100,36 @@ + doc + + oak-doc + + + + javadoc + + + + org.apache.maven.plugins + maven-javadoc-plugin + + + aggregate + + aggregate + + site + + + + ${basedir}/oak-doc/target/site + -notimestamp + + + + + + apache-release ${user.home}/.ssh/id_rsa Index: oak-doc/README.md IDEA additional info: Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP <+>UTF-8 =================================================================== --- oak-doc/README.md (revision 69728f1ff4c066f7773eb4f99c11bf77f2d2075e) +++ oak-doc/README.md (revision ) @@ -22,25 +22,33 @@ that it easy to view e.g. from GitHub. Alternatively the Maven site plugin can be used to build and deploy a web site as follows: -From the reactor use +From the reactor do - mvn site + mvn clean -Pdoc -to build the site without Javadoc or +to clean any existing site, - mvn site -Psite-with-javadoc + mvn site -Pdoc -to build the site with Javadoc. Review the site at `oak-doc/target/site`. +to build the site without Javadoc, and optionally + mvn site -Pjavadoc + +to add Javadoc. Review the site at `oak-doc/target/site`. + Then deploy the site to `http://jackrabbit.apache.org/oak/docs/` using - mvn site-deploy + mvn site-deploy -Pdoc Finally review the site at `http://jackrabbit.apache.org/oak/docs/index.html`. -To skip the final commit use `-Dscmpublish.skipCheckin=true`. You can then -review all pending changes in `oak-doc/target/scmpublish-checkout` and follow -up with `svn commit` manually. +To skip the final commit during the deploy phase you can specify +`-Dscmpublish.skipCheckin=true`. You can then review all pending changes in +`oak-doc/target/scmpublish-checkout` and follow up with `svn commit` manually. +*Note*: `mvn clean` needs to be run as a separate command as otherwise generating +the Javadocs would not work correctly due to issues with module ordering. + Every committer should be able to deploy the site. No fiddling with credentials needed since deployment is done via svn commit to `https://svn.apache.org/repos/asf/jackrabbit/site/live/oak/docs`. +