commit | b30d92b4a543f4746aa42d12afa150621b183bc8 | [log] [tgz] |
---|---|---|
author | Luciano Resende <lresende@apache.org> | Mon Aug 15 13:21:56 2016 -0700 |
committer | Luciano Resende <lresende@apache.org> | Mon Aug 15 13:36:15 2016 -0700 |
tree | 599920a0eb18eb8e39b36066bed595e02307b90a | |
parent | f8d356989c150427f4d85c1ff12e2f06864f4d63 [diff] |
[BAHIR-37] Publish Bahir 2.0.0 documentation Publish Bahir 2.0.0 documentation and update current documentation to use artifacts from master : 2.1.0-SNAPSHOT
The Apache Bahir website was forked from the Apache Website Template.
The website gets generated using Jekylland the instructions below assume you have Jekyll installed.
Before opening a pull request, you can preview your contributions by running from within the directory:
1. cd site 2. jekyll serve 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.