From commits-return-21661-archive-asf-public=cust-asf.ponee.io@accumulo.apache.org Fri Mar 30 21:42:08 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id CAACC180647 for ; Fri, 30 Mar 2018 21:42:07 +0200 (CEST) Received: (qmail 84770 invoked by uid 500); 30 Mar 2018 19:42:06 -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 84761 invoked by uid 99); 30 Mar 2018 19:42:06 -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, 30 Mar 2018 19:42:06 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id 5E22C82FF0; Fri, 30 Mar 2018 19:42:06 +0000 (UTC) Date: Fri, 30 Mar 2018 19:42:06 +0000 To: "commits@accumulo.apache.org" Subject: [accumulo-website] branch master updated: Improve committer instructions in readme (#73) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Message-ID: <152243892633.23995.8206826241193668654@gitbox.apache.org> From: kturner@apache.org X-Git-Host: gitbox.apache.org X-Git-Repo: accumulo-website X-Git-Refname: refs/heads/master X-Git-Reftype: branch X-Git-Oldrev: 015005c23ec0e300aeac7afb8bb5a8bc4f8f2b97 X-Git-Newrev: d8c0592d65e4ee47834990087507d5cd6b0865d4 X-Git-Rev: d8c0592d65e4ee47834990087507d5cd6b0865d4 X-Git-NotificationType: ref_changed_plus_diff X-Git-Multimail-Version: 1.5.dev Auto-Submitted: auto-generated This is an automated email from the ASF dual-hosted git repository. kturner pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/accumulo-website.git The following commit(s) were added to refs/heads/master by this push: new d8c0592 Improve committer instructions in readme (#73) d8c0592 is described below commit d8c0592d65e4ee47834990087507d5cd6b0865d4 Author: Keith Turner AuthorDate: Fri Mar 30 15:42:02 2018 -0400 Improve committer instructions in readme (#73) --- README.md | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 56f0bab..8db6b0e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ use [Bundler] to install the necessary dependencies to run and build the website ## Install Bundler and dependencies Ruby is required to use Bundler so first make sure you have Ruby on your machine. If you are using -an OS packaged version of Ruby, you will have to also install the ruby-dev (Ubuntu) or +an OS packaged version of Ruby, you will have to also install the ruby-dev (Ubuntu) or ruby-devel (Fedora) package as well. With Ruby installed on your machine, you can install [Bundler] using the command below: @@ -38,12 +38,34 @@ You can just build static HTML files which are viewable in `_config.yml`: ## Update the production website For Apache Accumulo committers, the `asf-site` branch needs to be updated with the generated -HTML. +HTML. Changes to this branch are automagically mirrored to the website. This can be done easily by invoking the post-commit hook (either by hand, or automatically via configuring -Git to invoke the post-commit hook). - -`./_devtools/git-hooks/post-commit` +Git to invoke the post-commit hook). The commands below are a guide for committers who wish to publish +the web site. + +```bash +# ensure local asf-site branch is up to date +git checkout asf-site +git pull upstream asf-site + +# switch to master branch, update it, and build new site +git checkout master +git pull upstream master +./_devtools/git-hooks/post-commit + +# switch to asf-site, look at the commit created by post-commit script, and push it if ok +git checkout asf-site +git log -p +git push upstream asf-site +``` +In the commands above `upstream` is : + +```bash +$ git remote -v | grep upstream +upstream https://gitbox.apache.org/repos/asf/accumulo-website/ (fetch) +upstream https://gitbox.apache.org/repos/asf/accumulo-website/ (push) +``` To automatically run this post-commit hook in your local repository, copy the given file into your `.git/hook` directory: -- To stop receiving notification emails like this one, please contact kturner@apache.org.