Mirror of Apache storm website Git repo
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data
_includes
_layouts
_plugins
_posts
_sass
about
assets
content
contribute
css
documentation
images
releases
.gitignore
Gemfile
Gemfile.lock
Powered-By.md
README.md
_config.yml
downloads.html
favicon.ico
favicon.png
feed.xml
getting-help.md
index.html
news.html
releases.html
talksAndVideos.md

README.md

Apache Storm Website and Documentation

This is the source for the Release specific part of the Apache Storm website and documentation. It is statically generated using jekyll.

Site Generation

First install jekyll and bundler (assuming you have ruby installed):

gem install jekyll bundler

Fetch/update site dependencies

bundle install

Generate the site, and start a server locally:

bundle exec 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.

Adding a new release to the website

In order to add a new release, you must have committer access to the storm-site repository at https://github.com/apache/storm-site.

You must first generate Javadoc for the new release. Check out the Storm repository from https://github.com/apache/storm, and check out the version of the code you are releasing.

In the Storm project root run

mvn javadoc:javadoc -Dnotimestamp=true
mvn javadoc:aggregate -DreportOutputDirectory=./docs/ -DdestDir=javadocs -Dnotimestamp=true

In the storm-site project, release documentation is placed under the releases directory named after the release version. See below for details about release specific documentation.

To add documentation for a new release, run the following from the Storm project root

mkdir ${path_to_storm_site}/releases/${release_name}
#Copy everything over, and compare checksums, except for things that are part of the site,
# and are not release specific like the _* directories that are jekyll specific
# assets/ css/ and README.md
rsync -ac --delete --exclude _\* --exclude assets --exclude css --exclude README.md ./docs/ ${path_to_storm_site}/releases/${release_name}
cd ${path_to_storm_site}
git add releases/${release_name}
git commit

To publish the site, run the following from the storm-site root

bundle exec jekyll build -d content
git add content
git commit

and push the commit to the asf-site branch.

How release specific docs work

Release specific documentation is controlled by a jekyll plugin releases.rb.

The plugin will look in the releases directory for release specific docs.

Each sub directory is named after the release in question. The "current" release is pointed to by a symlink in that directory called current.

The plugin sets three configs for each release page.

  • version - the version number of the release/directory
  • git-tree-base - a link to a directory in github that this version is on
  • git-blob-base - a link to to where on github that this version is on, but should be used when pointing to files.

The version is determined by the name of the releases/${release_name} sub-directory and branch is assumed to be a "v#{version}" which corresponds with our naming conventions. For SNAPSHOT releases you will need to override this in _data/releases.yml

The plugin also augments the site.data.releases dataset. Each release in the list includes the following, and each can be set in _data/releases.yml to override what is automatically generated by the plugin.

  • git-tag-or-branch - tag or branch name on github/apache/storm
  • git-tree-base - a link to a directory in github that this version is on
  • git-blob-base - a link to to where on github that this version is on, but should be used when pointing to files.
  • base-name - name of the release files to download, without the .tar.gz
  • has-download - if this is an official release and a download link should be created.

So if you wanted to create a link to a file on github inside the release specific docs you would create a link like

[LICENSE]([DEVELOPER.md]({{page.git-blob-base}}/LICENSE)

If you wanted to create a maven string to tell people what dependency to use you would do something like

<dependency>
  ...
  <version>{{version}}</version>
</dependency>

If you want to refer to a javadoc for the current release use a relative path. It will be in the javadocs subdirectory.

[TopologyBuilder](javadocs/org/apache/storm/topology/TopologyBuilder.html)