Samza's documentation uses Jekyll to build a website out of markdown pages. Prerequisites:
ruby --versionto check)
sudo gem install bundler
docsdirectory and run
To serve the website on localhost:4000:
bundle exec jekyll serve --watch
To compile the website in the _site directory, execute:
bundle exec jekyll build
The “Learn” section of this website is versioned. To add a new version, copy the folder at the version number-level (0.7.0 to 0.8.0, for example).
All links between pages inside a versioned folder should be relative links, not absolute.
To auto-generate the latest Javadocs, run:
The version number is the number that will be used in the /docs/learn/documentation//api/javadocs path.
To build and publish the website to Samza's Apache SVN repository, run:
_tools/publish-site.sh 0.7.0 "updating welcome page" criccomini
This command will re-build the Javadocs and website, checkout https://svn.apache.org/repos/asf/incubator/samza/site/ locally, copy the site into the directory, and commit the changes.