The FileVault documentation lives as Markdown files in src/site/markdown
such 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 build the site with javadoc:
$ mvn site
Review the site at site/target/site
Deploy the site to http://jackrabbit.apache.org/filevault-package-maven-plugin
using:
$ mvn site-deploy
Finally review the site at http://jackrabbit.apache.org/filevault-package-maven-plugin-archives/${project.version}/index.html
.
Note: To skip the final commit use -Dscmpublish.skipCheckin=true
. You can then review all pending changes in target/scmpublish-checkout
and follow up with svn commit
manually.
Note: 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/filevault-package-maven-plugin
.
Adjust the links to the site versions in src/site/site.xml
Deploy the site of the released version as described above (by switching to the release tag)
Copy the released version to the current one:
$ svn rm https://svn.apache.org/repos/asf/jackrabbit/site/live/filevault-package-maven-plugin $ svn cp https://svn.apache.org/repos/asf/jackrabbit/site/live/filevault-package-maven-plugin-archives/${project.version} \ https://svn.apache.org/repos/asf/jackrabbit/site/live/filevault-package-maven-plugin
Commit the changes from 1.
deploy the snapshot site