This is the website for Apache Beam, hosted at:
https://beam.apache.org/
The Beam website is built using Jekyll. Additionally, for additional formatting capabilities, this website uses Twitter Bootstrap.
This repository contains:
src/: the source of the site, including markdown files containing the bulk of the contentcontent/: html generated from the markdown (which is what is actually hosted on the website)
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.
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
Note: This is an optional method if you don't want to install gems locally and just use a container for development. The helper script is written for UNIX systems but should be fairly easy to modify to get it working on Windows.
Prerequisites: Make sure you have Docker installed on your machine.
For building the site, use the command ./run_with_docker.sh server. This will start the webserver inside a Docker container and port forward to your local machine at localhost:4000. We'll use the official Jekyll image to build the site.
For running the website tests, use ./run_with_docker.sh test.
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.
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.
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.