accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [accumulo-website] branch asf-site updated: Jekyll build from master:cc76bc2
Date Fri, 20 Oct 2017 20:20:36 GMT
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 <mwalch@apache.org>
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 @@
 
 <p>Accumulo has a number of <a href="/contributor/contrib-projects">contrib projects</a>
that maintain their own code repositories and release schedules.</p>
 
-<h3 id="website">Website</h3>
+<h3 id="project-website">Project Website</h3>
 
-<p>Accumulo’s web site is developed using <a href="https://jekyllrb.com">Jekyll</a>.
Development is
-performed by editing the contents of the <a href="https://gitbox.apache.org/repos/asf?p=accumulo-website.git;a=tree;h=master">accumulo-website
master</a> branch, either
-directly by a committer, with a pull request to <a href="https://github.com/apache/accumulo">GitHub</a>,
or a patch
-submitted to <a href="https://issues.apache.org/jira/browse/ACCUMULO">JIRA</a>.
The rendered site can be previewed locally and
-the rendered site (in the <code class="highlighter-rouge">_site</code> directory)
will be merged into the <code class="highlighter-rouge">asf-site</code>
-branch to update our <a href="https://accumulo.apache.org">official/canonical site</a>
after being built.</p>
+<p>The source for this website is a collection of markdown documents that are converted
to HTML using
+<a href="https://jekyllrb.com">Jekyll</a>. It can be found in the <a href="https://github.com/apache/accumulo">accumulo-website
repo</a>. If you would like to make changes to
+this website, clone the website repo and edit the markdown:</p>
 
-<p>To manage any Gem dependencies, it is highly recommended to use <a href="https://bundler.io">Bundler</a>.
-To start using Bundler, install it and then the dependencies for the website:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>gem install
bundler
-bundle install
-</code></pre>
-</div>
-
-<p>To get help with jekyll:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>jekyll help
+<div class="highlighter-rouge"><pre class="highlight"><code>git clone https://github.com/apache/accumulo-website.git
 </code></pre>
 </div>
 
-<p>To test the site locally (usually on http://localhost:4000):</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>jekyll serve
--safe
-</code></pre>
-</div>
-
-<p>To do the same with Bundler:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>bundle exec
jekyll serve --safe
-</code></pre>
-</div>
-
-<p>To build for updating the <code class="highlighter-rouge">asf-site</code>
branch:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>jekyll build
--safe
-</code></pre>
-</div>
-
-<p>To do the same with Bundler:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>bundle exec
jekyll build --safe
-</code></pre>
-</div>
-
-<p>For preview convenience and consistent builds and testing, build using a
-version which looks the same locally and on GitHub.</p>
-
-<p>A <a href="https://gitbox.apache.org/repos/asf?p=accumulo-website.git;a=blob_plain;f=_devtools/git-hooks/post-commit;hb=master">post-commit
hook</a> is available for you to automatically create a
-commit in the <code class="highlighter-rouge">asf-site</code> branch locally
each time you commit to the <code class="highlighter-rouge">master</code>
-branch. You can also run this command manually:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>./_devtools/git-hooks/post-commit
-</code></pre>
-</div>
-
-<p>To automatically run this post-commit hook in your local repository, copy
-the given file into your <code class="highlighter-rouge">.git/hook</code> directory:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>cp ./_devtools/git-hooks/post-commit
.git/hooks/
-</code></pre>
-</div>
+<p>After you have made your changes, follow the instructions in the <a href="https://github.com/apache/accumulo-website/blob/master/README.md">README.md</a>
to run the website
+locally and make a pull request on <a href="https://github.com/apache/accumulo">GitHub</a>.
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.</p>
 
 <h2 id="developers-guide">Developer’s Guide</h2>
 
diff --git a/feed.xml b/feed.xml
index 134f2a7..32aedf0 100644
--- a/feed.xml
+++ b/feed.xml
@@ -6,8 +6,8 @@
 </description>
     <link>https://accumulo.apache.org/</link>
     <atom:link href="https://accumulo.apache.org/feed.xml" rel="self" type="application/rss+xml"/>
-    <pubDate>Fri, 20 Oct 2017 12:29:15 -0400</pubDate>
-    <lastBuildDate>Fri, 20 Oct 2017 12:29:15 -0400</lastBuildDate>
+    <pubDate>Fri, 20 Oct 2017 16:19:44 -0400</pubDate>
+    <lastBuildDate>Fri, 20 Oct 2017 16:19:44 -0400</lastBuildDate>
     <generator>Jekyll v3.5.2</generator>
     
     

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

Mime
View raw message