You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pirk.apache.org by ea...@apache.org on 2016/07/12 18:34:11 UTC
[2/2] incubator-pirk git commit: updating website to include website
build/maintenance instructions
updating website to include website build/maintenance instructions
Project: http://git-wip-us.apache.org/repos/asf/incubator-pirk/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-pirk/commit/1bc2096b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-pirk/tree/1bc2096b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-pirk/diff/1bc2096b
Branch: refs/heads/gh-pages
Commit: 1bc2096badebd680dc76fc1338afc6c870a06487
Parents: e25c8a4
Author: eawilliams <ea...@apache.org>
Authored: Tue Jul 12 20:33:35 2016 +0200
Committer: eawilliams <ea...@apache.org>
Committed: Tue Jul 12 20:33:35 2016 +0200
----------------------------------------------------------------------
_includes/nav.html | 1 +
faq.md | 2 --
website_updates.md | 43 +++++++++++++++++++++++++++++++++++++++++++
3 files changed, 44 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/1bc2096b/_includes/nav.html
----------------------------------------------------------------------
diff --git a/_includes/nav.html b/_includes/nav.html
index 08c96e8..ea5e804 100755
--- a/_includes/nav.html
+++ b/_includes/nav.html
@@ -36,6 +36,7 @@
<ul class="dropdown-menu">
<li id="nav_releasing"><a href="{{ site.baseurl }}/releasing">Making Releases</a></li>
<li id="nav_nav_verify_release"><a href="{{ site.baseurl }}/verifying_releases">Verifying Releases</a></li>
+ <li id="nav_update_website"><a href="{{ site.baseurl }}/website_updates">Website Updates</a></li>
<hr>
<li><a href="https://issues.apache.org/jira/browse/PIRK ">Issue Tracker/JIRA <i class="fa fa-external-link"></i></a></li>
<li><a href="https://builds.apache.org/view/A/view/Accumulo">Jenkins Builds <i class="fa fa-external-link"></i></a></li>
http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/1bc2096b/faq.md
----------------------------------------------------------------------
diff --git a/faq.md b/faq.md
index 2222696..ddbcdce 100644
--- a/faq.md
+++ b/faq.md
@@ -5,6 +5,4 @@ nav: nav_faq
FAQ coming soon!
-Post commit test
-
http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/1bc2096b/website_updates.md
----------------------------------------------------------------------
diff --git a/website_updates.md b/website_updates.md
new file mode 100644
index 0000000..b12978d
--- /dev/null
+++ b/website_updates.md
@@ -0,0 +1,43 @@
+---
+title: Updating the Website
+nav: nav_website_updates
+---
+
+Pirk's web site is developed using [Jekyll](https://jekyllrb.com). The Jekyll source is contained in the [gh-pages](https://git-wip-us.apache.org/repos/asf?p=incubator-pirk.git;a=tree;h=gh-pages) branch and the [asf-site](https://git-wip-us.apache.org/repos/asf?p=incubator-pirk.git;a=tree;h=asf-site) branch contains the HTML content.
+
+Website development is
+performed by editing the contents of the [gh-pages](https://git-wip-us.apache.org/repos/asf?p=incubator-pirk.git;a=tree;h=gh-pages) branch, either
+directly by a committer, with a pull request to [GitHub](https://github.com/apache/incubator-pirk), or a patch
+submitted to [JIRA](https://issues.apache.org/jira/browse/PIRK). The rendered site can be previewed locally or on
+[GitHub](https://apache.github.io/incubator-pirk/), and the rendered site (in the `_site` directory) will be
+merged into the `asf-site` branch to update the [official site](http://pirk.incubator.apache.org/) after being built with the `_config-asf.yml` configuration.
+
+To manage any Gem dependencies, it is highly recommended to use [Bundler](https://bundler.io).
+To start using Bundler, install it and then install the dependencies for the website:
+
+ gem install bundler
+ bundle install
+
+To get help with jekyll:
+
+ jekyll help
+
+To test the site locally (usually on http://localhost:4000):
+
+ bundle exec jekyll serve --config _config-asf.yml --safe
+
+To build for updating the `asf-site` branch:
+
+ bundle exec jekyll build --config _config-asf.yml --safe
+
+A [post-commit hook](https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=blob_plain;f=_devtools/git-hooks/post-commit;hb=gh-pages) is available (Thanks [Apache Accumulo!](https://accumulo.apache.org/)) for you to automatically create a
+commit in the `asf-site` branch locally each time you commit to the `gh-pages`
+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/
+
\ No newline at end of file