accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ktur...@apache.org
Subject [accumulo-website] branch master updated: Improve committer instructions in readme (#73)
Date Fri, 30 Mar 2018 19:42:06 GMT
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 <keith@deenlo.com>
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.

Mime
View raw message