Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id CC56F200D0E for ; Tue, 26 Sep 2017 17:23:33 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id CAAF41609B4; Tue, 26 Sep 2017 15:23:33 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 1DD141609C1 for ; Tue, 26 Sep 2017 17:23:32 +0200 (CEST) Received: (qmail 53346 invoked by uid 500); 26 Sep 2017 15:23:32 -0000 Mailing-List: contact commits-help@fluo.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@fluo.apache.org Delivered-To: mailing list commits@fluo.apache.org Received: (qmail 53337 invoked by uid 99); 26 Sep 2017 15:23:32 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 26 Sep 2017 15:23:32 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id 972D78186C; Tue, 26 Sep 2017 15:23:31 +0000 (UTC) Date: Tue, 26 Sep 2017 15:23:31 +0000 To: "commits@fluo.apache.org" Subject: [fluo-website] branch gh-pages updated: Added CONTRIBUTING.md (#91) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Message-ID: <150643941157.18384.6822340677750143133@gitbox.apache.org> From: kturner@apache.org Reply-To: "commits@fluo.apache.org" X-Git-Host: gitbox.apache.org X-Git-Repo: fluo-website X-Git-Refname: refs/heads/gh-pages X-Git-Reftype: branch X-Git-Oldrev: 1555a5075c18cc3e8809d2bbd938b395fb76e23b X-Git-Newrev: f20a41fd2efe121b8d80e71800e9781b4bd7e36b X-Git-Rev: f20a41fd2efe121b8d80e71800e9781b4bd7e36b X-Git-NotificationType: ref_changed_plus_diff X-Git-Multimail-Version: 1.5.dev Auto-Submitted: auto-generated archived-at: Tue, 26 Sep 2017 15:23:34 -0000 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 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 @@ + + +# 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" '].