fluo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ktur...@apache.org
Subject [fluo-website] branch gh-pages updated: Added CONTRIBUTING.md (#91)
Date Tue, 26 Sep 2017 15:23:31 GMT
This is an automated email from the ASF dual-hosted git repository.

kturner pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/fluo-website.git


The following commit(s) were added to refs/heads/gh-pages by this push:
     new f20a41f  Added CONTRIBUTING.md (#91)
f20a41f is described below

commit f20a41fd2efe121b8d80e71800e9781b4bd7e36b
Author: Keith Turner <keith@deenlo.com>
AuthorDate: Tue Sep 26 11:23:29 2017 -0400

    Added CONTRIBUTING.md (#91)
---
 CONTRIBUTING.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       | 27 +--------------------------
 2 files changed, 49 insertions(+), 26 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..b487381
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,48 @@
+<!--
+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.
+-->
+
+# Contributing to Fluo Website
+
+Contributions to the website can be made by submitting pull requests to this repo.  Checkout
[How to
+Contribute][contribute] on for general instructions on contributing to Fluo projects.
+
+# Testing locally
+
+If you want to view your changes in your browser before submitting a pull request, 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 fluo-website/
+        bundle install
+
+3. Run the following command to have Jekyll serve the website locally:
+
+        bundle exec jekyll serve --watch
+
+4. Open your web browser to [http://localhost:4000](http://localhost:4000).
+
+[contribute]: https://fluo.apache.org/how-to-contribute/
+[Jekyll]: http://jekyllrb.com/
+[Bundler]: http://bundler.io/
+[Gemfile]: Gemfile
+
diff --git a/README.md b/README.md
index f291832..919b766 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,7 @@
 # Apache Fluo website
 
 Code powering the Apache Fluo website ([https://fluo.apache.org](https://fluo.apache.org)).
-
-## Contributions
-
-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 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 fluo-website/
-        bundle install
-
-3. Run the following command to have Jekyll serve the website locally:
-
-        bundle exec jekyll serve --watch
-
-4. Open your web browser to [http://localhost:4000](http://localhost:4000).
+[Contributing](CONTRIBUTING.md) decribes how to test locally.
 
 ## Apache Fluo releases
 
@@ -64,7 +42,4 @@ Steps to update website for new Fluo Recipes release:
 
 4. Create a post in `_posts/release` with release notes and resources to announce release.
 
-[Jekyll]: http://jekyllrb.com/
-[Bundler]: http://bundler.io/
-[Gemfile]: Gemfile
 [instructions]: http://jekyllrb.com/docs/installation/

-- 
To stop receiving notification emails like this one, please contact
['"commits@fluo.apache.org" <commits@fluo.apache.org>'].

Mime
View raw message