These are the main sources of the website for Apache Beam, hosted at https://beam.apache.org/.
Documentation generated from source code, such as Javadoc and Pydoc, is stored separately on the beam-site repository.
Website development requires Docker installed if you wish to preview changes and run website tests.
The following command is used to build and serve the website locally.
$ ./gradlew :beam-website:serveWebsite
Any changes made locally will trigger a rebuild of the website.
Websites tests may be run using this command:
$ ./gradlew :beam-website:testWebsite
Blog posts are created in the
If this is your first post, make sure to add yourself to
While you a working on your post before the publishing time listed in its header, add
--future when running Jekyll in order to view your draft on your local copy of the site.
If you modify the site to use additional Jekyll plugins, add them in
Gemfile and then run
bundle update, which will regenerate the complete
Gemfile.lock. Make sure that the updated
Gemfile.lock is included in your pull request. For more information, see the Bundler documentation.