accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [accumulo-website] branch master updated: ACCUMULO-4727 Updated instructions for running the website (#29)
Date Fri, 20 Oct 2017 20:02:27 GMT
This is an automated email from the ASF dual-hosted git repository.

mwalch 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 cc76bc2  ACCUMULO-4727 Updated instructions for running the website (#29)
cc76bc2 is described below

commit cc76bc2a50d69bb7ed4e0a20dc834da19f546b89
Author: Mike Walch <mwalch@apache.org>
AuthorDate: Fri Oct 20 16:02:25 2017 -0400

    ACCUMULO-4727 Updated instructions for running the website (#29)
---
 README.md             | 40 +++++++++++++++++++++++++++---------
 contributor/source.md | 57 ++++++++++-----------------------------------------
 2 files changed, 41 insertions(+), 56 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.md b/contributor/source.md
index 0f3f316..bf7701a 100644
--- a/contributor/source.md
+++ b/contributor/source.md
@@ -26,54 +26,18 @@ Instructions for configuring git are [here][git-instr].
 
 Accumulo has a number of [contrib projects][contrib] that maintain their own code repositories
and release schedules.
 
-### Website
+### Project Website
 
-Accumulo's web site is developed using [Jekyll][jekyll]. Development is
-performed by editing the contents of the [accumulo-website master][website-branch] branch,
either
-directly by a committer, with a pull request to [GitHub][github], or a patch
-submitted to [JIRA][jiraloc]. 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][site-canon] 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][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](https://bundler.io).
-To start using Bundler, install it and then the dependencies for the website:
+    git clone https://github.com/apache/accumulo-website.git
 
-    gem install bundler
-    bundle install
-
-To get help with jekyll:
-
-    jekyll help
-
-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][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][website-readme]
to run the website
+locally and make a pull request on [GitHub][website-repo]. 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
 
@@ -208,10 +172,11 @@ Accumulo has [guidelines for using Review Board][rb] to support code
reviews.
 [cgit]: https://gitbox.apache.org/repos/asf?p=accumulo.git;a=summary
 [contrib]: {{ "/contributor/contrib-projects" | relative_url }}
 [devlist]: mailto:dev@accumulo.apache.org
-[website-branch]: https://gitbox.apache.org/repos/asf?p=accumulo-website.git;a=tree;h=master
 [git-instr]: https://gitbox.apache.org
 [git]: https://git-scm.com
 [github]: https://github.com/apache/accumulo
+[website-repo]: https://github.com/apache/accumulo
+[website-readme]: https://github.com/apache/accumulo-website/blob/master/README.md
 [hook]: https://gitbox.apache.org/repos/asf?p=accumulo-website.git;a=blob_plain;f=_devtools/git-hooks/post-commit;hb=master
 [intellij-formatter]: https://code.google.com/p/eclipse-code-formatter-intellij-plugin
 [jekyll]: https://jekyllrb.com

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

Mime
View raw message