You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fluo.apache.org by mw...@apache.org on 2016/08/02 15:46:08 UTC

[3/4] incubator-fluo-website git commit: Several more updates website

Several more updates website

* Updated install instructions in README
* Improved Apache branding in README
* Upgrade github-pages version to 89
* Fixed misspellings


Project: http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/commit/86921ab9
Tree: http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/tree/86921ab9
Diff: http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/diff/86921ab9

Branch: refs/heads/gh-pages
Commit: 86921ab9780a4f322eca2762923cf9c148086f88
Parents: 10e5f6e
Author: Mike Walch <mw...@gmail.com>
Authored: Tue Aug 2 09:52:31 2016 -0400
Committer: Mike Walch <mw...@gmail.com>
Committed: Tue Aug 2 11:43:32 2016 -0400

----------------------------------------------------------------------
 Gemfile         |  2 +-
 Gemfile.lock    | 83 +++++++++++++++++++++++++---------------------------
 README.md       | 37 +++++++++++++----------
 docs/index.md   |  2 +-
 docs/pre-asf.md |  2 +-
 5 files changed, 65 insertions(+), 61 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/86921ab9/Gemfile
----------------------------------------------------------------------
diff --git a/Gemfile b/Gemfile
index 922c3fd..26663c8 100644
--- a/Gemfile
+++ b/Gemfile
@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'github-pages', '67'
+gem 'github-pages', '89'

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/86921ab9/Gemfile.lock
----------------------------------------------------------------------
diff --git a/Gemfile.lock b/Gemfile.lock
index 806cef2..a9dd8b1 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -1,8 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    RedCloth (4.2.9)
-    activesupport (4.2.6)
+    activesupport (4.2.7)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -14,35 +13,33 @@ GEM
       execjs
     coffee-script-source (1.10.0)
     colorator (0.1)
-    ethon (0.8.1)
+    ethon (0.9.0)
       ffi (>= 1.3.0)
-    execjs (2.6.0)
+    execjs (2.7.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.10)
+    ffi (1.9.14)
     gemoji (2.1.0)
-    github-pages (67)
-      RedCloth (= 4.2.9)
+    github-pages (89)
+      activesupport (= 4.2.7)
       github-pages-health-check (= 1.1.0)
-      jekyll (= 3.0.3)
+      jekyll (= 3.1.6)
       jekyll-coffeescript (= 1.0.1)
-      jekyll-feed (= 0.4.0)
+      jekyll-feed (= 0.5.1)
       jekyll-gist (= 1.4.0)
-      jekyll-github-metadata (= 1.10.0)
-      jekyll-mentions (= 1.1.2)
+      jekyll-github-metadata (= 2.0.2)
+      jekyll-mentions (= 1.1.3)
       jekyll-paginate (= 1.1.0)
-      jekyll-redirect-from (= 0.10.0)
+      jekyll-redirect-from (= 0.11.0)
       jekyll-sass-converter (= 1.3.0)
-      jekyll-seo-tag (= 1.3.2)
+      jekyll-seo-tag (= 2.0.0)
       jekyll-sitemap (= 0.10.0)
-      jekyll-textile-converter (= 0.1.0)
-      jemoji (= 0.6.2)
-      kramdown (= 1.10.0)
+      jemoji (= 0.7.0)
+      kramdown (= 1.11.1)
       liquid (= 3.0.6)
+      listen (= 3.0.6)
       mercenary (~> 0.3)
-      rdiscount (= 2.1.8)
-      redcarpet (= 3.3.3)
-      rouge (= 1.10.1)
+      rouge (= 1.11.1)
       terminal-table (~> 1.4)
     github-pages-health-check (1.1.0)
       addressable (~> 2.3)
@@ -50,11 +47,11 @@ GEM
       octokit (~> 4.0)
       public_suffix (~> 1.4)
       typhoeus (~> 0.7)
-    html-pipeline (2.4.0)
-      activesupport (>= 2, < 5)
+    html-pipeline (2.4.2)
+      activesupport (>= 2)
       nokogiri (>= 1.4)
     i18n (0.7.0)
-    jekyll (3.0.3)
+    jekyll (3.1.6)
       colorator (~> 0.1)
       jekyll-sass-converter (~> 1.0)
       jekyll-watch (~> 1.1)
@@ -65,58 +62,58 @@ GEM
       safe_yaml (~> 1.0)
     jekyll-coffeescript (1.0.1)
       coffee-script (~> 2.2)
-    jekyll-feed (0.4.0)
+    jekyll-feed (0.5.1)
     jekyll-gist (1.4.0)
       octokit (~> 4.2)
-    jekyll-github-metadata (1.10.0)
+    jekyll-github-metadata (2.0.2)
+      jekyll (~> 3.1)
       octokit (~> 4.0)
-    jekyll-mentions (1.1.2)
+    jekyll-mentions (1.1.3)
       html-pipeline (~> 2.3)
       jekyll (~> 3.0)
     jekyll-paginate (1.1.0)
-    jekyll-redirect-from (0.10.0)
+    jekyll-redirect-from (0.11.0)
       jekyll (>= 2.0)
     jekyll-sass-converter (1.3.0)
       sass (~> 3.2)
-    jekyll-seo-tag (1.3.2)
-      jekyll (~> 3.0)
+    jekyll-seo-tag (2.0.0)
+      jekyll (~> 3.1)
     jekyll-sitemap (0.10.0)
-    jekyll-textile-converter (0.1.0)
-      RedCloth (~> 4.0)
-    jekyll-watch (1.3.1)
-      listen (~> 3.0)
-    jemoji (0.6.2)
+    jekyll-watch (1.5.0)
+      listen (~> 3.0, < 3.1)
+    jemoji (0.7.0)
+      activesupport (~> 4.0)
       gemoji (~> 2.0)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0)
     json (1.8.3)
-    kramdown (1.10.0)
+    kramdown (1.11.1)
     liquid (3.0.6)
     listen (3.0.6)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
     mercenary (0.3.6)
-    mini_portile2 (2.0.0)
-    minitest (5.8.4)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
     multipart-post (2.0.0)
     net-dns (0.8.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
     octokit (4.3.0)
       sawyer (~> 0.7.0, >= 0.5.3)
+    pkg-config (1.1.7)
     public_suffix (1.5.3)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
-    rdiscount (2.1.8)
-    redcarpet (3.3.3)
-    rouge (1.10.1)
+    rouge (1.11.1)
     safe_yaml (1.0.4)
     sass (3.4.22)
     sawyer (0.7.0)
       addressable (>= 2.3.5, < 2.5)
       faraday (~> 0.8, < 0.10)
-    terminal-table (1.5.2)
+    terminal-table (1.6.0)
     thread_safe (0.3.5)
     typhoeus (0.8.0)
       ethon (>= 0.8.0)
@@ -127,7 +124,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  github-pages (= 67)
+  github-pages (= 89)
 
 BUNDLED WITH
    1.11.2

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/86921ab9/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index ab87b21..684a3fa 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,31 @@
-Fluo website
-============
+# Apache Fluo website
 
-Code powering the Fluo project website ([https://fluo.apache.org](https://fluo.apache.org)).
+Code powering the Apache Fluo website ([https://fluo.apache.org](https://fluo.apache.org)).
 
-Contributions
--------------
+## Contributions
+
+Contributions to the website can be made by submitting pull requests to this repo.
 
-Contributions to the website can be made by submitting pull requests to this repo. 
 If you want to view your changes in your browser before submitting a pull request, 
-you will need install [Jekyll] on your machine by following these [instructions].
-You will also need to install all gems in the [Gemfile].
+you will need install all of the gems in the [Gemfile] to serve the website in your
+browser using [Jekyll]. This can be done by following these instructions:
+
+1. After you have Ruby and RubyGems installed on your machine, install [Bundler]:
+
+        gem install bundler
+
+2. Use [Bundler] to install all gems in the [Gemfile] of this repo.
+
+        cd incubator-fluo-website/
+        bundle install
 
-Once Jekyll is installed, use the following command to run the development server:
+3. Run the following command to have Jekyll serve the website locally:
 
-    jekyll serve --watch
+        bundle exec jekyll serve --watch
 
-Next, open a web browser to [http://localhost:4000](http://localhost:4000).
+4. Open your web browser to [http://localhost:4000](http://localhost:4000).
 
-Fluo releases
--------------
+## Apache Fluo releases
 
 Below are the steps required to update the Fluo project website for a new release 
 (substitute `1.0.0-beta-1` with the version of your release):
@@ -47,8 +54,7 @@ Below are the steps required to update the Fluo project website for a new releas
 
 5. Create a blog post announcing the release in `_posts/blog/`
 
-Fluo Recipes releases
----------------------
+## Apache Fluo Recipes releases
 
 Steps to update website for new Fluo Recipes release:
 
@@ -73,5 +79,6 @@ Steps to update website for new Fluo Recipes release:
 4. Modify `apidocs/index.md` to point to the new javadocs that you just generated.
 
 [Jekyll]: http://jekyllrb.com/
+[Bundler]: http://bundler.io/
 [Gemfile]: Gemfile
 [instructions]: http://jekyllrb.com/docs/installation/

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/86921ab9/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index 88bb10e..3017ef1 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -15,7 +15,7 @@ The first release of Apache Fluo Recipes has not been made yet.
 
 ## Pre Apache Documentation
 
-Documentation about releases made before Apahce Fluo entered incubation at Apache has been moved [here](pre-asf)
+Documentation about releases made before Apache Fluo entered incubation at Apache has been moved [here](pre-asf)
 
 [Apache Fluo]: https://github.com/apache/fluo
 [Apache Fluo Recipes]: https://github.com/apache/fluo-recipes

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/86921ab9/docs/pre-asf.md
----------------------------------------------------------------------
diff --git a/docs/pre-asf.md b/docs/pre-asf.md
index 1130482..b9e1df5 100644
--- a/docs/pre-asf.md
+++ b/docs/pre-asf.md
@@ -3,7 +3,7 @@ layout: page
 title: Pre Apache Documentation
 ---
 
-<div class="alert alert-danger" role="alert">Please note - This is documentation related to non-ASF releases of Fluo.  These releases were made before Apahce Fluo became an ASF project.</div>
+<div class="alert alert-danger" role="alert">Please note - This is documentation related to non-ASF releases of Fluo.  These releases were made before Apache Fluo became an ASF project.</div>
 
 ## Fluo