tree: 80c74715495eb077b3af573572a46be72d4e9996 [path history] [tgz]
  1. .gitattributes
  2. .github/
  3. .gitignore
  4. .jenkins/
  5. Dockerfile
  6. Gemfile
  7. Gemfile.lock
  8. OWNERS
  9. README.md
  10. Rakefile
  11. _config.yml
  12. build.gradle
  13. src/
website/README.md

Apache Beam website

The website source code is currently being migrated from https://github.com/apache/beam-site, but is not yet ready. Please continue to contribute changes at apache/beam-site according to the website contribution guide. You can track migration progress via [BEAM-4493].

This is the website for Apache Beam, hosted at:

https://beam.apache.org/

About this site

The Beam website is built using Jekyll. Additionally, for additional formatting capabilities, this website uses Twitter Bootstrap.

Repository Structure

This repository contains:

  1. src/: the source of the site, including markdown files containing the bulk of the content
  2. content/: html generated from the markdown (which is what is actually hosted on the website)

Development Workflow

Setup

You need Ruby version >= 2.2.0 to build the project.

Install Ruby Gems, a package management framework for Ruby.

Install Bundler, which we use to specify dependencies and ensure a consistent environment for building the website, even across multiple developers on different machines:

$ gem install bundler

Use Bundler to download the versions of each dependency specified in the website's Gemfile.lock, including Jekyll:

$ bundle install --deployment

This will install a number of gems in a local ./vendor directory.

Active development

Launch Jekyll via Bundler in order to guarantee that the appropriate versions of the dependencies are used:

$ bundle exec jekyll serve

Jekyll will start a webserver on port 4000. As you make changes to the content, Jekyll will rebuild it automatically. This is helpful if you want to see how your changes will render in realtime.

In addition, check for dead links and the like by running the tests via:

$ bundle exec rake test

Running Jekyll may cause the content/ directory to be generated. Merging autogenerated content can get tricky, so regenerating content is responsibility of the committer doing the final merge of your PR, and your PR should not contain changes to that directory.

Before sending the PR for review, please run:

$ git checkout -- content

Additional Information

Writing blog posts

Blog posts are created in the _posts directory.

If this is your first post, make sure to add yourself to _data\authors.yml.

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.

Adding Jekyll plugins

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.

Apache License

Except as otherwise noted this software is licensed under the Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.