You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@griffin.apache.org by gu...@apache.org on 2018/09/12 09:19:59 UTC
incubator-griffin-site git commit: readme
Repository: incubator-griffin-site
Updated Branches:
refs/heads/master ca1c37a79 -> e931bbcd8
readme
Project: http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/commit/e931bbcd
Tree: http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/tree/e931bbcd
Diff: http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/diff/e931bbcd
Branch: refs/heads/master
Commit: e931bbcd8ed9aa48bc5abf426410c266e44d7a8e
Parents: ca1c37a
Author: William Guo <gu...@apache.org>
Authored: Wed Sep 12 17:19:48 2018 +0800
Committer: William Guo <gu...@apache.org>
Committed: Wed Sep 12 17:19:48 2018 +0800
----------------------------------------------------------------------
README.md | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/e931bbcd/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..75d8600
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Griffin Documentation Site
+Welcome to the Apache Griffin documentation!
+
+## Prerequisites
+
+Install [jekyll](https://jekyllrb.com/) gem
+
+ $ gem install jekyll
+
+Generate the site, and start a server locally:
+
+ $ jekyll serve -w
+
+The `-w` option tells jekyll to watch for changes to files and regenerate the site automatically when any content changes.
+
+Point your browser to [http://localhost:4000](http://localhost:4000)
+
+By default, jekyll will generate the site in a `_site` directory.
+
+## Editing documentations
+1. Create a markdown file and add following content in header
+
+ ---
+ layout: doc
+ title: "Griffin Overview"
+ permalink: /docs/some-new-doc.html
+ ---
+
+ More content here ..
+
+## Publishing the Apache Website
+In order to publish the website, you must have committer access to Griffin's apache repository.
+
+To publish changes, run
+
+```
+bash ./deploy.sh
+```