tree: 43373d8492681171356646f3c75f064254276160 [path history] [tgz]
  1. README.md
  2. _config.yml
  3. _includes/
  4. _layouts/
  5. _posts/
  6. _sass/
  7. about.md
  8. about/
  9. assets/
  10. css/
  11. doc-index.html
  12. documentation/
  13. downloads.html
  14. feed.xml
  15. images/
  16. index.html
  17. news.html
docs/README.md

Apache Storm Website and Documentation

This is the source for the Storm website and documentation. It is statically generated using jekyll.

Generate Javadoc

You have to generate javadoc on project root before generating document site.

mvn clean install -Pdist # you may skip tests with `-DskipTests=true` to save time

You need to create distribution package with gpg certificate. Please refer here.

Site Generation

First install jekyll (assuming you have ruby installed):

gem install jekyll

Generate the site, and start a server locally:

cd docs
jekyll serve -w

The -w option tells jekyll to watch for changes to files and regenerate the site automatically when any content changes.

Point your browser to http://localhost:4000

By default, jekyll will generate the site in a _site directory.

Publishing the Website

In order to publish the website, you must have committer access to Storm's subversion repository.

The Storm website is published using Apache svnpubsub. Any changes committed to subversion will be automatically published to storm.apache.org.

To publish changes, tell jekyll to generate the site in the publish directory of subversion, then commit the changes:

cd docs
jekyll build -d /path/to/svn/repo/publish
cd /path/to/svn/repo/publish
svn commit