commit | b536ac52d5d35d8b9e21887efb70cdbb5d4e86de | [log] [tgz] |
---|---|---|
author | Tzu-Li (Gordon) Tai <tzulitai@apache.org> | Wed Mar 01 16:53:14 2017 +0800 |
committer | Luciano Resende <lresende@apache.org> | Mon Mar 13 17:08:03 2017 -0700 |
tree | f44879658307d9e66a7f6ca65f4d37ec8239aa71 | |
parent | 9c5bcb98a2a91108f1a6f9e29b18826abb6b6fa9 [diff] |
[BAHIR-90] Include Apache Flink extensions to website This commit setups links for documentation and downloads for Apache Bahir Flink extensions. The Flink docs are generated using the updated update-docs.sh script in #8. It also revamps the website's project infrastructure, configuration, and navigation / layouts for documentations and the download page to be more friendly for newly supported platforms in the future. Closes #9
The Apache Bahir website was forked from the Apache Website Template.
The website gets generated using Jekyll.
The steps below will install the latest Jekyll version and any dependencies required to get this website built.
1. sudo gem install jekyll bundler 2. cd site 3. sudo bundle install
For more information, see Installing Jekyll.
Before opening a pull request, you can preview your contributions by running from within the directory:
1. cd site 2. bundle exec jekyll serve --watch 3. Open [http://localhost:4000](http://localhost:4000)
To update the current documentation contents, use the update-doc script. This script will update the documentation contents based on the README.md files from the source of each extension.
1. update-doc.sh 2. git commit -a -m "My updates" 3. git push 4. ./publish.sh 5. git push origin asf-site
Bahir is using gitpubsub for publishing the website, and the live website content is stored in the asf-site git branch.
To publish new contents to the website, commit your changes to master, and use the ‘publish.sh’ shell script.
1. Make your changes 2. git commit -a -m "My updates" 3. git push 4. ./publish.sh 5. git push origin asf-site
Within a few minutes, gitpubsub should kick in and you'll be able to see the results at bahir.apache.org.
To add a contributor to the project, or to modify existing contributors, edit site/_data/contributors.yml
. The project members list will be re-generated.