You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bahir.apache.org by lr...@apache.org on 2016/10/27 23:29:02 UTC
[2/2] bahir-website git commit: Update website README.md
Update website README.md
Add instructions to install/update Jekyll and how to
install/update website dependencies using bundle tool.
Project: http://git-wip-us.apache.org/repos/asf/bahir-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/bahir-website/commit/2df4250d
Tree: http://git-wip-us.apache.org/repos/asf/bahir-website/tree/2df4250d
Diff: http://git-wip-us.apache.org/repos/asf/bahir-website/diff/2df4250d
Branch: refs/heads/master
Commit: 2df4250dd8b1c9589ec2f334c6e2c118d3175111
Parents: 613370a
Author: Luciano Resende <lr...@apache.org>
Authored: Fri Oct 28 01:27:59 2016 +0200
Committer: Luciano Resende <lr...@apache.org>
Committed: Fri Oct 28 01:27:59 2016 +0200
----------------------------------------------------------------------
README.md | 56 ++++++++++++++++++++++++++++++++------------------------
1 file changed, 32 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/bahir-website/blob/2df4250d/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index c72acee..fef7ef9 100644
--- a/README.md
+++ b/README.md
@@ -17,31 +17,43 @@ limitations under the License.
{% endcomment %}
-->
-# Apache Bahir Website
+Apache Bahir Website
+====================
The Apache Bahir website was forked from the [Apache Website Template](https://github.com/apache/apache-website-template).
-The website gets generated using [Jekyll](https://jekyllrb.com/)and the instructions below assume you have [Jekyll installed](https://jekyllrb.com/docs/installation/).
+The website gets generated using [Jekyll](https://jekyllrb.com/).
-# How to deploy your project's web site
+How to deploy your project's web site
+=====================================
-## Running locally
+Installing Jekyll and website dependencies
+------------------------------------------
-Before opening a pull request, you can preview your contributions by
-running from within the directory:
+The steps below will install the latest [Jekyll](https://jekyllrb.com/) version and any dependencies required to get this website built.
+
+```
+1. sudo gem install jekyll bundler
+2. sudo bundle install
+```
+
+For more information, see [Installing Jekyll](https://jekyllrb.com/docs/installation/).
+
+Running locally
+---------------
+
+Before opening a pull request, you can preview your contributions by running from within the directory:
```
1. cd site
-2. jekyll serve
+2. bundle exec jekyll serve --watch
3. Open [http://localhost:4000](http://localhost:4000)
```
+Update extensions documentation
+-------------------------------
-## Update extensions documentation
-
-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.
+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
@@ -51,15 +63,12 @@ files from the source of each extension.
5. git push origin asf-site
```
+Publishing to live site
+-----------------------
+Bahir is using [gitpubsub](http://www.apache.org/dev/gitpubsub.html) for publishing the website, and the live website content is stored in the asf-site git branch.
-## Publishing to live site
-
-Bahir is using [gitpubsub](http://www.apache.org/dev/gitpubsub.html) 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.
+To publish new contents to the website, commit your changes to master, and use the 'publish.sh' shell script.
```
1. Make your changes
@@ -69,10 +78,9 @@ shell script.
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](https://bahir.apache.org/).
+Within a few minutes, gitpubsub should kick in and you'll be able to see the results at [bahir.apache.org](https://bahir.apache.org/).
-## Adding contributors
+Adding contributors
+-------------------
-To add a contributor to the project, or to modify existing contributors, edit `site/_data/contributors.yml`.
-The [project members](http://localhost:4000/community-members) list will be re-generated.
+To add a contributor to the project, or to modify existing contributors, edit `site/_data/contributors.yml`. The [project members](http://localhost:4000/community-members) list will be re-generated.