Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To get CMS and the zookeeper source, run the following:

Code Block

$ svn co https://svn.apache.org/repos/asf/zookeeper/site/trunk zookeeper-site
$ svn co https://svn.apache.org/repos/infra/websites/cms cms

Generate the documentation with:

Code Block

$ cms/build/build_site.pl --source-base zookeeper-site/ --target-base output

...

When making a release, you need to generate the version's documentation and then copy it into zookeeper-site/content/bookkeeper/docs. To do this:

  1. Copy the documentation directory from the release tag to zookeeper-site/content/bookkeeper/docs.

    Code Block
    $ cp -r bookkeeper-svn/tags/release-4.1.0/doc/ zookkeeperzookeeper-site/content/bookkeeper/docs/r4.1.0

    Add to subversion.

  2. Generate the javadoc for the release. In bookkeeper-svn/tags/release-4.1.0/ run mvn javadoc:aggregate. This will create bookkeeper-svn/tags/release-4.1.0/target/site/apidocs. Copy this to zookeeper-site/content/bookkeeper/docs/r4.1.0 and add it to subversion.
  3. Modify zookeeper-site/content/bookkeeper/docs/r4.1.0/index.textile to point to the javadoc and release notes. See zookeeper-site/content/bookkeeper/docs/r4.0.0/index.textile for an example of how to do this.
  4. Modify zookeeper-site/templates/bookkeeper/sidenav.textile and and a link for the release documentation.
  5. Add the release to zookeeper-site/content/bookkeeper/releases.textile.
  6. Go through the staging/publish sequence from above. Obviously the version numbers will change for each release.