tree: 30385c3bfee827ed11c60909e6928ec9464afa71 [path history] [tgz]
  1. Gemfile
  2. Gemfile.lock
  3. Makefile
  4. README.md
  5. _config.yml
  6. _layouts/
  7. _tools/
  8. community/
  9. contribute/
  10. css/
  11. fonts/
  12. img/
  13. index.md
  14. js/
  15. learn/
  16. less/
  17. sitemap.xml
  18. startup/
docs/README.md

Setup

Samza's documentation uses Jekyll to build a website out of markdown pages. Prerequisites:

  1. You need Ruby installed on your machine (run ruby --version to check)
  2. Install Bundler by running sudo gem install bundler
  3. To install Jekyll and its dependencies, change to the docs directory and run bundle install

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

Versioning

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.

Javadocs

To auto-generate the latest Javadocs, run:

_tools/generate-javadocs.sh <version>

The version number is the number that will be used in the /docs/learn/documentation//api/javadocs path.

Release

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.