tree: b465bdeb690df7e007b829ace6e5767dc77d6c9b [path history] [tgz]
  1. src/
  2. pom.xml
  3. README.md
vault-doc/README.md

FileVault Documentation

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:

  1. From the reactor build the site with javadoc:

    $ mvn site
    
  2. Review the site at vault-doc/target/site

  3. Deploy the site to http://jackrabbit.apache.org/filevault/ using:

    $ cd vault-doc
    $ mvn site-deploy
    
  4. Finally review the site at http://jackrabbit.apache.org/filevault/index.html.

Note: To skip the final commit use -Dscmpublish.skipCheckin=true. You can then review all pending changes in vault-doc/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.