You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by ma...@apache.org on 2014/06/25 00:02:23 UTC
git commit: SAMZA-297: Fix the version of Jekyll (and deps) for
building docs.
Repository: incubator-samza
Updated Branches:
refs/heads/0.7.0 00da59fac -> aa0e7636c
SAMZA-297: Fix the version of Jekyll (and deps) for building docs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-samza/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-samza/commit/aa0e7636
Tree: http://git-wip-us.apache.org/repos/asf/incubator-samza/tree/aa0e7636
Diff: http://git-wip-us.apache.org/repos/asf/incubator-samza/diff/aa0e7636
Branch: refs/heads/0.7.0
Commit: aa0e7636c77a5d16e1bbc7c56c1b7e8ed46cae21
Parents: 00da59f
Author: Martin Kleppmann <mk...@linkedin.com>
Authored: Wed Jun 18 11:36:16 2014 -0700
Committer: Martin Kleppmann <mk...@linkedin.com>
Committed: Tue Jun 24 23:01:44 2014 +0100
----------------------------------------------------------------------
docs/Gemfile | 18 ++++++++++++
docs/Gemfile.lock | 62 ++++++++++++++++++++++++++++++++++++++++
docs/README.md | 14 +++++----
docs/_config.yml | 2 +-
docs/_tools/publish-site.sh | 2 +-
docs/contribute/code.md | 10 +------
6 files changed, 91 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/aa0e7636/docs/Gemfile
----------------------------------------------------------------------
diff --git a/docs/Gemfile b/docs/Gemfile
new file mode 100644
index 0000000..3571e42
--- /dev/null
+++ b/docs/Gemfile
@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+source 'https://rubygems.org'
+gem 'jekyll'
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/aa0e7636/docs/Gemfile.lock
----------------------------------------------------------------------
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
new file mode 100644
index 0000000..8a236e6
--- /dev/null
+++ b/docs/Gemfile.lock
@@ -0,0 +1,62 @@
+GEM
+ remote: https://rubygems.org/
+ specs:
+ blankslate (2.1.2.4)
+ celluloid (0.15.2)
+ timers (~> 1.1.0)
+ classifier (1.3.4)
+ fast-stemmer (>= 1.0.0)
+ coffee-script (2.2.0)
+ coffee-script-source
+ execjs
+ coffee-script-source (1.7.0)
+ colorator (0.1)
+ execjs (2.2.0)
+ fast-stemmer (1.0.2)
+ ffi (1.9.3)
+ jekyll (2.0.3)
+ classifier (~> 1.3)
+ colorator (~> 0.1)
+ jekyll-coffeescript (~> 1.0)
+ jekyll-sass-converter (~> 1.0)
+ kramdown (~> 1.3)
+ liquid (~> 2.5.5)
+ listen (~> 2.5)
+ mercenary (~> 0.3.3)
+ pygments.rb (~> 0.5.0)
+ redcarpet (~> 3.1)
+ safe_yaml (~> 1.0)
+ toml (~> 0.1.0)
+ jekyll-coffeescript (1.0.0)
+ coffee-script (~> 2.2)
+ jekyll-sass-converter (1.0.0)
+ sass (~> 3.2)
+ kramdown (1.4.0)
+ liquid (2.5.5)
+ listen (2.7.8)
+ celluloid (>= 0.15.2)
+ rb-fsevent (>= 0.9.3)
+ rb-inotify (>= 0.9)
+ mercenary (0.3.3)
+ parslet (1.5.0)
+ blankslate (~> 2.0)
+ posix-spawn (0.3.8)
+ pygments.rb (0.5.4)
+ posix-spawn (~> 0.3.6)
+ yajl-ruby (~> 1.1.0)
+ rb-fsevent (0.9.4)
+ rb-inotify (0.9.5)
+ ffi (>= 0.5.0)
+ redcarpet (3.1.2)
+ safe_yaml (1.0.3)
+ sass (3.3.8)
+ timers (1.1.0)
+ toml (0.1.1)
+ parslet (~> 1.5.0)
+ yajl-ruby (1.1.0)
+
+PLATFORMS
+ ruby
+
+DEPENDENCIES
+ jekyll
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/aa0e7636/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 0edd84e..955280e 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -16,17 +16,19 @@
-->
## Setup
-Samza's documentation uses Jekyll to build a website out of markdown pages. To install Jekyll, run this command:
+Samza's documentation uses Jekyll to build a website out of markdown pages. Prerequisites:
- sudo gem install jekyll redcarpet
+1. You need [Ruby](https://www.ruby-lang.org/) installed on your machine (run `ruby --version` to check)
+2. Install [Bundler](http://bundler.io/) by running `sudo gem install bundler`
+3. To install Jekyll and its dependencies, change to the `docs` directory and run `bundle install`
-To run the website locally, execute:
+To serve the website on [localhost:4000](http://localhost:4000/):
- jekyll serve --watch --host 0.0.0.0
+ bundle exec jekyll serve --watch
-To compile the website in the _site directory, execute:
+To compile the website in the \_site directory, execute:
- jekyll build
+ bundle exec jekyll build
## Versioning
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/aa0e7636/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index 9ffb45c..2f2f895 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -16,7 +16,7 @@
# under the License.
permalink: /:categories/:title
name: Samza
-pygments: true
+highlighter: pygments
markdown: redcarpet
exclude: ['_notes']
redcarpet:
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/aa0e7636/docs/_tools/publish-site.sh
----------------------------------------------------------------------
diff --git a/docs/_tools/publish-site.sh b/docs/_tools/publish-site.sh
index b20c4e7..a65e760 100755
--- a/docs/_tools/publish-site.sh
+++ b/docs/_tools/publish-site.sh
@@ -40,7 +40,7 @@ $DOCS_DIR/_tools/generate-javadocs.sh $VERSION
echo "Building site."
cd $DOCS_DIR
-jekyll build
+bundle exec jekyll build
echo "Checking out SVN site."
SVN_TMP=`mktemp -d /tmp/samza-svn.XXXX`
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/aa0e7636/docs/contribute/code.md
----------------------------------------------------------------------
diff --git a/docs/contribute/code.md b/docs/contribute/code.md
index b9a3c02..b43160b 100644
--- a/docs/contribute/code.md
+++ b/docs/contribute/code.md
@@ -31,12 +31,4 @@ Please see the [Rules](rules.html) page for information on how to contribute.
If you are a committer you need to use https instead of http to check in, otherwise you will get an error regarding an inability to acquire a lock. Note that older versions of git may also give this error even when the repo was cloned with https; if you experience this try a newer version of git.
-The Samza website is built by Jekyll from the markdown files found in the docs subdirectory. For committers wishing to update the webpage first install Jekyll:
-
-```
-gem install jekyll
-```
-
-Depending on your system you may also need install some additional dependencies when you try and run it. Note that some Linux distributions may have older versions of Jekyll packaged that treat arguments differently and may result in changes not being incorporated into the generated site.
-
-The script to commit the updated webpage files is docs/_tools/publish-site.sh
+The Samza website is built by Jekyll from the markdown files found in the docs subdirectory. For committers wishing to update the webpage, please see `docs/README.md` for instructions.