kylin-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From luke...@apache.org
Subject [44/50] [abbrv] incubator-kylin git commit: KYLIN-884 restructure docs and website
Date Tue, 21 Jul 2015 08:05:50 GMT
KYLIN-884 restructure docs and website


Project: http://git-wip-us.apache.org/repos/asf/incubator-kylin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-kylin/commit/37037d04
Tree: http://git-wip-us.apache.org/repos/asf/incubator-kylin/tree/37037d04
Diff: http://git-wip-us.apache.org/repos/asf/incubator-kylin/diff/37037d04

Branch: refs/heads/master
Commit: 37037d048922145401c417f62c9f43255b58e68e
Parents: 9f64637
Author: Luke Han <lukehan@apache.org>
Authored: Fri Jul 10 14:57:08 2015 +0800
Committer: Luke Han <lukehan@apache.org>
Committed: Fri Jul 10 14:57:08 2015 +0800

----------------------------------------------------------------------
 docs/website/README.md     | 49 +++++++++++++++++++++++++++++++++++++++--
 docs/website/docs/index.md |  5 +++++
 2 files changed, 52 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/37037d04/docs/website/README.md
----------------------------------------------------------------------
diff --git a/docs/website/README.md b/docs/website/README.md
index fbb2844..b6e7a63 100644
--- a/docs/website/README.md
+++ b/docs/website/README.md
@@ -1,2 +1,47 @@
-# kylin.io
-kylin.io site with Jekyll and markdown
+<!--
+{% comment %}
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+{% endcomment %}
+-->
+
+# Apache Kylin website  
+This directory contains the source code for the Apache Kylin (incubating) website:
+[http://kyin.incubator.apache.org](http://kylin.incubator.apache.org/).
+
+## Setup
+
+1. `cd docs/website`
+2. `svn co https://svn.apache.org/repos/asf/incubator/kylin/site _site`
+3. `sudo apt-get install rubygems ruby2.1-dev zlib1g-dev` (linux)
+4. `sudo gem install bundler github-pages jekyll`
+5. `bundle install`
+
+## Running locally  
+Before opening a pull request or push to git repo, you can preview changes from your local
box with following:
+
+1. `cd docs/website`
+2. `jekyll s`
+3. Open [http://localhost:4000](http://localhost:4000)
+
+## Pushing to site (for committer only)  
+1. `cd docs/website/_site`
+2. `svn status`
+3. You'll need to `svn add` any new files
+4. `svn commit -m 'UPDATE MESSAGE'`
+
+Within a few minutes, svnpubsub should kick in and you'll be able to
+see the results at
+[http://kylin.incubator.apache.org](http://kylin.incubator.apache.org/).
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/37037d04/docs/website/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/website/docs/index.md b/docs/website/docs/index.md
index b073db3..043501d 100644
--- a/docs/website/docs/index.md
+++ b/docs/website/docs/index.md
@@ -46,3 +46,8 @@ Advanced Topics
 
 2.[Job Engine Design](docs/JobEngine/Design.md)
 
+
+## Disclaimer
+
+Apache Kylin is an effort undergoing incubation at The Apache Software Foundation (ASF),
sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until
a further review indicates that the infrastructure, communications, and decision making process
have stabilized in a manner consistent with other successful ASF projects. While incubation
status is not necessarily a reflection of the completeness or stability of the code, it does
indicate that the project has yet to be fully endorsed by the ASF.
+


Mime
View raw message