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 97438200D31 for ; Fri, 20 Oct 2017 22:20:40 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 95EF81609ED; Fri, 20 Oct 2017 20:20:40 +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 E3CF5160BCB for ; Fri, 20 Oct 2017 22:20:39 +0200 (CEST) Received: (qmail 1530 invoked by uid 500); 20 Oct 2017 20:20:39 -0000 Mailing-List: contact commits-help@accumulo.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@accumulo.apache.org Delivered-To: mailing list commits@accumulo.apache.org Received: (qmail 1521 invoked by uid 99); 20 Oct 2017 20:20:39 -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; Fri, 20 Oct 2017 20:20:39 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id 0945281DC8; Fri, 20 Oct 2017 20:20:36 +0000 (UTC) Date: Fri, 20 Oct 2017 20:20:36 +0000 To: "commits@accumulo.apache.org" Subject: [accumulo-website] branch asf-site updated: Jekyll build from master:cc76bc2 MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Message-ID: <150853083618.15251.3566288930864476847@gitbox.apache.org> From: mwalch@apache.org X-Git-Host: gitbox.apache.org X-Git-Repo: accumulo-website X-Git-Refname: refs/heads/asf-site X-Git-Reftype: branch X-Git-Oldrev: ad257e57cb5a753b4c1a8f0caa08054b6dccbe45 X-Git-Newrev: df06cebe3847afbe87f84b2e4687ec9bde72993d X-Git-Rev: df06cebe3847afbe87f84b2e4687ec9bde72993d X-Git-NotificationType: ref_changed_plus_diff X-Git-Multimail-Version: 1.5.dev Auto-Submitted: auto-generated archived-at: Fri, 20 Oct 2017 20:20:40 -0000 This is an automated email from the ASF dual-hosted git repository. mwalch pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/accumulo-website.git The following commit(s) were added to refs/heads/asf-site by this push: new df06ceb Jekyll build from master:cc76bc2 df06ceb is described below commit df06cebe3847afbe87f84b2e4687ec9bde72993d Author: Mike Walch AuthorDate: Fri Oct 20 16:19:56 2017 -0400 Jekyll build from master:cc76bc2 ACCUMULO-4727 Updated instructions for running the website (#29) --- README.md | 40 +++++++++++++++++++++-------- contributor/source.html | 68 +++++++------------------------------------------ feed.xml | 4 +-- 3 files changed, 41 insertions(+), 71 deletions(-) diff --git a/README.md b/README.md index 13e7cc0..ec88309 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,35 @@ # Apache Accumulo Website -Apache Accumulo uses [Jekyll](http://jekyllrb.com/) to build their website. It is recommended -that you use [Bundler](http://bundler.io/) to manage any dependencies of the build for you. +Apache Accumulo uses [Jekyll] to build their website. It is recommended that you +use [Bundler] to install the necessary dependencies to run and build the website. ## Install Bundler and dependencies -`gem install bundler` -`bundle install` +With Ruby installed on your machine, you can install [Bundler] using the command below: -## Build the website + gem install bundler -Jekyll lets you either build the static HTML files or create an embedded webserver -to interact with the local version of the website. +Next, use [Bundler] to install [Jekyll] and other dependencies needed to run the website. -`bundle exec jekyll build` + git clone https://github.com/apache/accumulo-website + cd accumulo-website + bundle install -or +## Run the website locally -`bundle exec jekyll serve -w` +Run the following command to run the website locally using Jekyll's embedded webserver: + + cd accumulo-website + bundle exec jekyll serve -w + +The website can viewed at [http://0.0.0.0:4000/](http://0.0.0.0:4000/) + +## Build website static HTML files + +You can just build static HTML files which are viewable in `_config.yml`: + + cd accumulo-website + bundle exec jekyll build ## Update the production website @@ -28,3 +40,11 @@ This can be done easily by invoking the post-commit hook (either by hand, or aut Git to invoke the post-commit hook). `./_devtools/git-hooks/post-commit` + +To automatically run this post-commit hook in your local repository, copy +the given file into your `.git/hook` directory: + + cp ./_devtools/git-hooks/post-commit .git/hooks/ + +[Jekyll]: https://jekyllrb.com/ +[Bundler]: https://bundler.io/ diff --git a/contributor/source.html b/contributor/source.html index 05af6a7..180fb97 100644 --- a/contributor/source.html +++ b/contributor/source.html @@ -168,70 +168,20 @@

Accumulo has a number of contrib projects that maintain their own code repositories and release schedules.

-

Website

+

Project Website

-

Accumulo’s web site is developed using Jekyll. Development is -performed by editing the contents of the accumulo-website master branch, either -directly by a committer, with a pull request to GitHub, or a patch -submitted to JIRA. The rendered site can be previewed locally and -the rendered site (in the _site directory) will be merged into the asf-site -branch to update our official/canonical site after being built.

+

The source for this website is a collection of markdown documents that are converted to HTML using +Jekyll. It can be found in the accumulo-website repo. If you would like to make changes to +this website, clone the website repo and edit the markdown:

-

To manage any Gem dependencies, it is highly recommended to use Bundler. -To start using Bundler, install it and then the dependencies for the website:

- -
gem install bundler
-bundle install
-
-
- -

To get help with jekyll:

- -
jekyll help
+
git clone https://github.com/apache/accumulo-website.git
 

 

 
-
To test the site locally (usually on http://localhost:4000):

-
-
jekyll serve --safe
-

-

-
-
To do the same with Bundler:

-
-
bundle exec jekyll serve --safe
-

-

-
-
To build for updating the asf-site branch:

-
-
jekyll build --safe
-

-

-
-
To do the same with Bundler:

-
-
bundle exec jekyll build --safe
-

-

-
-
For preview convenience and consistent builds and testing, build using a
-version which looks the same locally and on GitHub.

-
-
A post-commit hook is available for you to automatically create a
-commit in the asf-site branch locally each time you commit to the master
-branch. You can also run this command manually:

-
-
./_devtools/git-hooks/post-commit
-

-

-
-
To automatically run this post-commit hook in your local repository, copy
-the given file into your .git/hook directory:

-
-
cp ./_devtools/git-hooks/post-commit .git/hooks/
-

-

+
After you have made your changes, follow the instructions in the README.md to run the website
+locally and make a pull request on GitHub. If you have problems installing Jekyll or running the
+website locally, it’s OK to proceed with the pull request. A committer will review your changes before committing
+them and updating the website.

 
 
Developer’s Guide

 
diff --git a/feed.xml b/feed.xml
index 134f2a7..32aedf0 100644
--- a/feed.xml
+++ b/feed.xml
@@ -6,8 +6,8 @@
 
     https://accumulo.apache.org/
     
-    Fri, 20 Oct 2017 12:29:15 -0400
-    Fri, 20 Oct 2017 12:29:15 -0400
+    Fri, 20 Oct 2017 16:19:44 -0400
+    Fri, 20 Oct 2017 16:19:44 -0400
     Jekyll v3.5.2
     
     

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