You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by lu...@apache.org on 2015/07/15 14:48:10 UTC
[3/7] incubator-kylin git commit: KYLIN-884 re-structure website,
using new menu, move to root dir
KYLIN-884 re-structure website, using new menu, move to root dir
Project: http://git-wip-us.apache.org/repos/asf/incubator-kylin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-kylin/commit/3a5829c7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-kylin/tree/3a5829c7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-kylin/diff/3a5829c7
Branch: refs/heads/0.7-staging
Commit: 3a5829c7d56362a0f3b0cf0b9ea876f71a44ce83
Parents: eb9c51e
Author: Luke Han <lu...@apache.org>
Authored: Wed Jul 15 18:01:42 2015 +0800
Committer: Luke Han <lu...@apache.org>
Committed: Wed Jul 15 18:01:42 2015 +0800
----------------------------------------------------------------------
docs/README.md | 6 +
docs/release_notes.md | 193 --
website/_config.yml | 10 +-
website/_data/docs.yml | 14 +-
.../development/Build Cube with Restful API.md | 51 -
...w to consume Kylin REST API in javascript.md | 42 -
.../_docs/development/Kylin Restful API List.md | 2020 ------------------
...n Kylin test case with HBase Mini Cluster.md | 15 -
website/_docs/development/build_cube_rest.md | 55 -
website/_docs/development/metadata_store.md | 5 +-
website/_docs/development/new_metadata.md | 5 +-
website/_docs/development/rest_api.md | 215 +-
website/_docs/development/test_minicluster.md | 5 +-
website/_docs/development/web_tech.md | 5 +-
.../gettingstarted/Apache Kylin 2014 Dec.pdf | Bin 2043052 -> 0 bytes
.../gettingstarted/Design Cube in Kylin.pdf | Bin 339155 -> 0 bytes
.../What-should-I-use-Kylin-for.md | 55 -
website/_docs/gettingstarted/events.md | 3 +-
website/_docs/gettingstarted/faq.md | 5 -
website/_docs/gettingstarted/terminology.md | 18 +-
...w to install kylin in your Hadoop cluster.md | 53 -
website/_docs/howto/howto_backup.md | 8 +-
website/_docs/howto/howto_contribute.md | 2 +
website/_docs/howto/howto_javascript.md | 48 -
website/_docs/howto/howto_jdbc.md | 6 +-
website/_docs/howto/howto_package.md | 17 +-
website/_docs/howto/howto_release.md | 6 +-
website/_docs/howto/howto_upgrade.md | 9 +
website/_docs/index.cn.md | 4 +-
.../Advance-settings-of-Kylin-environment.md | 36 -
...f-Hadoop-CLI-Installation-(Dev-Env-Setup).md | 94 -
...On-Hadoop-Kylin-installation-using-Docker.md | 42 -
website/_docs/install/hadoop_evn.md | 2 -
website/_docs/install/index.md | 2 -
website/_docs/install/kylin_cluster.md | 2 -
.../_docs/install/manual_install_guide.cn.md | 2 +
website/_docs/install/manual_install_guide.md | 8 +-
website/_docs/tutorial/acl.cn.md | 8 +-
website/_docs/tutorial/acl.md | 8 +-
website/_docs/tutorial/create_cube.cn.md | 7 +-
website/_docs/tutorial/create_cube.md | 9 +-
website/_docs/tutorial/cube_build_job.cn.md | 4 +-
website/_docs/tutorial/cube_build_job.md | 6 +-
website/_docs/tutorial/odbc.cn.md | 7 +-
website/_docs/tutorial/odbc.md | 6 +-
website/_docs/tutorial/tableau.cn.md | 7 +-
website/_docs/tutorial/tableau.md | 6 +-
website/_docs/tutorial/web.cn.md | 6 +-
website/_docs/tutorial/web.md | 6 +-
website/_layouts/docs.html | 6 +-
website/download/index.cn.md | 26 +-
website/download/index.md | 23 +-
52 files changed, 283 insertions(+), 2915 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/3a5829c7/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..166f9fd
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,6 @@
+# Apache Kylin Documentation
+
+__All documentations have been moved to Kylin website at:__
+[http://kylin.incubator.apache.org/docs](http://kylin.incubator.apache.org/docs)
+
+Please visit there for furthe reference.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/3a5829c7/docs/release_notes.md
----------------------------------------------------------------------
diff --git a/docs/release_notes.md b/docs/release_notes.md
deleted file mode 100644
index b91f56b..0000000
--- a/docs/release_notes.md
+++ /dev/null
@@ -1,193 +0,0 @@
-<!--
-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.
--->
-
-# Apache Kylin Release Notes
-
-## v0.7.2-incubating
-_Tag:_ [kylin-0.7.2-incubating](https://github.com/apache/incubator-kylin/tree/kylin-0.7.2-incubating)
-
-
-__Detail JIRA and notes will coming after verify__
-
-** Sub-task
-
- * [KYLIN-812] - Upgrade to Calcite 0.9.2
-
-** Bug
-
- * [KYLIN-457] - "ERROR Could not instantiate appender" from log4j when tomcat startup
- * [KYLIN-514] - Error message is not helpful to user when doing something in Jason Editor window
- * [KYLIN-518] - Cannot select Right join type if current join type is Left join type
- * [KYLIN-598] - Kylin detecting hive table delim failure
- * [KYLIN-632] - "kylin.sh stop" doesn't check whether KYLIN_HOME was set
- * [KYLIN-660] - Make configurable of dictionary cardinality cap
- * [KYLIN-693] - Couldn't change a cube's name after it be created
- * [KYLIN-814] - Duplicate columns error for subqueries on fact table
- * [KYLIN-819] - Fix necessary ColumnMetaData order for Calcite (Optic)
- * [KYLIN-824] - Cube Build fails if lookup table doesn't have any files under HDFS location
- * [KYLIN-829] - Cube "Actions" shows "NA"; but after expand the "access" tab, the button shows up
- * [KYLIN-830] - Cube merge failed after migrating from v0.6 to v0.7
- * [KYLIN-831] - Kylin report "Column 'ABC' not found in table 'TABLE' while executing SQL", when that column is FK but not define as a dimension
- * [KYLIN-840] - HBase table compress not enabled even LZO is installed
- * [KYLIN-847] - "select * from fact" does not work on 0.7 branch
- * [KYLIN-848] - Couldn't resume or discard a cube job
- * [KYLIN-849] - Couldn't query metrics on lookup table PK
- * [KYLIN-865] - Cube has been built but couldn't query; In log it said "Realization 'CUBE.CUBE_NAME' defined under project PROJECT_NAME is not found
- * [KYLIN-873] - cancel button does not work when [resume][discard] job
-
-## v0.7.1-incubating (First Apache Release) - 2015-06-10
-_Tag:_ [kylin-0.7.1-incubating](https://github.com/apache/incubator-kylin/tree/kylin-0.7.1-incubating)
-
-Apache Kylin v0.7.1-incubating has rolled out on June 10, 2015. This is also the first Apache release after join incubating.
-
-To download this release, please visit: [http://kylin.incubator.apache.org/download/](http://kylin.incubator.apache.org/download/), there are source code package, binary package, ODBC driver and installation guide avaliable.
-
-Any problem or issue, please send to Apache Kylin mailing list: [dev@kylin.incubator.apache.org](mailto:dev@kylin.incubator.apache.org)
-
-Or, report to Apache Kylin JIRA project: [https://issues.apache.org/jira/browse/KYLIN](https://issues.apache.org/jira/browse/KYLIN)
-
-
-__Main Changes:__
-
-* Package renamed from com.kylinolap to org.apache.kylin
-* Code cleaned up to apply Apache License policy
-* Easy install and setup with bunch of scripts and automation
-* Job engine refactor to be generic job manager for all jobs, and improved efficiency
-* Support Hive database other than 'default'
-* JDBC driver avaliable for client to interactive with Kylin server
-* Binary pacakge avaliable download
-
-__New Feature__
-
- * [KYLIN-327] - Binary distribution
- * [KYLIN-368] - Move MailService to Common module
- * [KYLIN-540] - Data model upgrade for legacy cube descs
- * [KYLIN-576] - Refactor expansion rate expression
-
-__Task__
-
- * [KYLIN-361] - Rename package name with Apache Kylin
- * [KYLIN-531] - Rename package name to org.apache.kylin
- * [KYLIN-533] - Job Engine Refactoring
- * [KYLIN-585] - Simplify deployment
- * [KYLIN-586] - Add Apache License header in each source file
- * [KYLIN-587] - Remove hard copy of javascript libraries
- * [KYLIN-624] - Add dimension and metric info into DataModel
- * [KYLIN-650] - Move all document from github wiki to code repository (using md file)
- * [KYLIN-669] - Release v0.7.1 as first apache release
-
-__Sub-task__
-
- * [KYLIN-670] - Update pom with "incubating" in version number
- * [KYLIN-737] - Generate and sign release package for review and vote
- * [KYLIN-795] - Release after success vote
-
-__Bug__
-
- * [KYLIN-132] - Job framework
- * [KYLIN-194] - Dict & ColumnValueContainer does not support number comparison, they do string comparison right now
- * [KYLIN-220] - Enable swap column of Rowkeys in Cube Designer
- * [KYLIN-230] - Error when create HTable
- * [KYLIN-255] - Error when a aggregated function appear twice in select clause
- * [KYLIN-383] - Sample Hive EDW database name should be replaced by "default" in the sample
- * [KYLIN-399] - refreshed segment not correctly published to cube
- * [KYLIN-412] - No exception or message when sync up table which can't access
- * [KYLIN-421] - Hive table metadata issue
- * [KYLIN-436] - Can't sync Hive table metadata from other database rather than "default"
- * [KYLIN-508] - Too high cardinality is not suitable for dictionary!
- * [KYLIN-509] - Order by on fact table not works correctly
- * [KYLIN-517] - Always delete the last one of Add Lookup page buttom even if deleting the first join condition
- * [KYLIN-524] - Exception will throw out if dimension is created on a lookup table, then deleting the lookup table.
- * [KYLIN-547] - Create cube failed if column dictionary sets false and column length value greater than 0
- * [KYLIN-556] - error tip enhance when cube detail return empty
- * [KYLIN-570] - Need not to call API before sending login request
- * [KYLIN-571] - Dimensions lost when creating cube though Joson Editor
- * [KYLIN-572] - HTable size is wrong
- * [KYLIN-581] - unable to build cube
- * [KYLIN-583] - Dependency of Hive conf/jar in II branch will affect auto deploy
- * [KYLIN-588] - Error when run package.sh
- * [KYLIN-593] - angular.min.js.map and angular-resource.min.js.map are missing in kylin.war
- * [KYLIN-594] - Making changes in build and packaging with respect to apache release process
- * [KYLIN-595] - Kylin JDBC driver should not assume Kylin server listen on either 80 or 443
- * [KYLIN-605] - Issue when install Kylin on a CLI which does not have yarn Resource Manager
- * [KYLIN-614] - find hive dependency shell fine is unable to set the hive dependency correctly
- * [KYLIN-615] - Unable add measures in Kylin web UI
- * [KYLIN-619] - Cube build fails with hive+tez
- * [KYLIN-620] - Wrong duration number
- * [KYLIN-621] - SecurityException when running MR job
- * [KYLIN-627] - Hive tables' partition column was not sync into Kylin
- * [KYLIN-628] - Couldn't build a new created cube
- * [KYLIN-629] - Kylin failed to run mapreduce job if there is no mapreduce.application.classpath in mapred-site.xml
- * [KYLIN-630] - ArrayIndexOutOfBoundsException when merge cube segments
- * [KYLIN-638] - kylin.sh stop not working
- * [KYLIN-639] - Get "Table 'xxxx' not found while executing SQL" error after a cube be successfully built
- * [KYLIN-640] - sum of float not working
- * [KYLIN-642] - Couldn't refresh cube segment
- * [KYLIN-643] - JDBC couldn't connect to Kylin: "java.sql.SQLException: Authentication Failed"
- * [KYLIN-644] - join table as null error when build the cube
- * [KYLIN-652] - Lookup table alias will be set to null
- * [KYLIN-657] - JDBC Driver not register into DriverManager
- * [KYLIN-658] - java.lang.IllegalArgumentException: Cannot find rowkey column XXX in cube CubeDesc
- * [KYLIN-659] - Couldn't adjust the rowkey sequence when create cube
- * [KYLIN-666] - Select float type column got class cast exception
- * [KYLIN-681] - Failed to build dictionary if the rowkey's dictionary property is "date(yyyy-mm-dd)"
- * [KYLIN-682] - Got "No aggregator for func 'MIN' and return type 'decimal(19,4)'" error when build cube
- * [KYLIN-684] - Remove holistic distinct count and multiple column distinct count from sample cube
- * [KYLIN-691] - update tomcat download address in download-tomcat.sh
- * [KYLIN-696] - Dictionary couldn't recognize a value and throw IllegalArgumentException: "Not a valid value"
- * [KYLIN-703] - UT failed due to unknown host issue
- * [KYLIN-711] - UT failure in REST module
- * [KYLIN-739] - Dimension as metrics does not work with PK-FK derived column
- * [KYLIN-761] - Tables are not shown in the "Query" tab, and couldn't run SQL query after cube be built
-
-__Improvement__
-
- * [KYLIN-168] - Installation fails if multiple ZK
- * [KYLIN-182] - Validation Rule: columns used in Join condition should have same datatype
- * [KYLIN-204] - Kylin web not works properly in IE
- * [KYLIN-217] - Enhance coprocessor with endpoints
- * [KYLIN-251] - job engine refactoring
- * [KYLIN-261] - derived column validate when create cube
- * [KYLIN-317] - note: grunt.json need to be configured when add new javascript or css file
- * [KYLIN-324] - Refactor metadata to support InvertedIndex
- * [KYLIN-407] - Validation: There's should no Hive table column using "binary" data type
- * [KYLIN-445] - Rename cube_desc/cube folder
- * [KYLIN-452] - Automatically create local cluster for running tests
- * [KYLIN-498] - Merge metadata tables
- * [KYLIN-532] - Refactor data model in kylin front end
- * [KYLIN-539] - use hbase command to launch tomcat
- * [KYLIN-542] - add project property feature for cube
- * [KYLIN-553] - From cube instance, couldn't easily find the project instance that it belongs to
- * [KYLIN-563] - Wrap kylin start and stop with a script
- * [KYLIN-567] - More flexible validation of new segments
- * [KYLIN-569] - Support increment+merge job
- * [KYLIN-578] - add more generic configuration for ssh
- * [KYLIN-601] - Extract content from kylin.tgz to "kylin" folder
- * [KYLIN-616] - Validation Rule: partition date column should be in dimension columns
- * [KYLIN-634] - Script to import sample data and cube metadata
- * [KYLIN-636] - wiki/On-Hadoop-CLI-installation is not up to date
- * [KYLIN-637] - add start&end date for hbase info in cubeDesigner
- * [KYLIN-714] - Add Apache RAT to pom.xml
- * [KYLIN-753] - Make the dependency on hbase-common to "provided"
- * [KYLIN-758] - Updating port forwarding issue Hadoop Installation on Hortonworks Sandbox.
- * [KYLIN-779] - [UI] jump to cube list after create cube
- * [KYLIN-796] - Add REST API to trigger storage cleanup/GC
-
-__Wish__
-
- * [KYLIN-608] - Distinct count for ii storage
-
http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/3a5829c7/website/_config.yml
----------------------------------------------------------------------
diff --git a/website/_config.yml b/website/_config.yml
index 63448c5..cc17a87 100644
--- a/website/_config.yml
+++ b/website/_config.yml
@@ -30,8 +30,12 @@ include: [_docs]
# Build settings
markdown: kramdown
-# Code highlight
-highlighter: pygments
+kramdown:
+ input: GFM
+ syntax_highlighter: rouge
+
+highlighter: rouge
+
# Permalinks, default is pretty
# permalink: /:categories/:title.html
permalink: pretty
@@ -39,7 +43,7 @@ permalink: pretty
google_analytics_id: UA-55534813-2
# Multiple Languages Plugin
-gems: ['jekyll-multiple-languages']
+gems: ['jekyll-multiple-languages', 'kramdown', 'rouge']
# Supported Languages
languages: ['en','cn']
language_default: 'en'
http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/3a5829c7/website/_data/docs.yml
----------------------------------------------------------------------
diff --git a/website/_data/docs.yml b/website/_data/docs.yml
index 050d485..de113dd 100644
--- a/website/_data/docs.yml
+++ b/website/_data/docs.yml
@@ -1,6 +1,7 @@
- title: Getting Started
docs:
- index
+ - release_notes
- gettingstarted/faq
- gettingstarted/events
- gettingstarted/terminology
@@ -8,7 +9,10 @@
- title: Installation
docs:
- install/index
+ - install/hadoop_env
- install/manual_install_guide
+ - install/kylin_cluster
+ - install/advance_settings
- title: Tutorial
docs:
@@ -25,19 +29,23 @@
- howto/howto_jdbc
- howto/howto_javascript
- howto/howto_backup
+ - howto/howto_upgrade
- howto/howto_release
+
- title: Development
docs:
- - development/build_cube_rest
+ - development/dev_env
- development/metadata_store
- development/new_metadata
- development/rest_api
- - development/test_minicluster
+ - development/build_api
+ - development/javascript_api
- development/web_tech
+ - development/test_minicluster
+
- title: Meta
docs:
- - contributing
- history
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/3a5829c7/website/_docs/development/Build Cube with Restful API.md
----------------------------------------------------------------------
diff --git a/website/_docs/development/Build Cube with Restful API.md b/website/_docs/development/Build Cube with Restful API.md
deleted file mode 100644
index 4eb5381..0000000
--- a/website/_docs/development/Build Cube with Restful API.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-### 1. Authentication
-* Currently, Kylin uses [basic authentication](http://en.wikipedia.org/wiki/Basic_access_authentication).
-* Add `Authorization` header to first request for authentication
-* Or you can do a specific request by `POST http://localhost:7070/kylin/api/user/authentication`
-* Once authenticated, client can go subsequent requests with cookies.
-* Example
-```
- POST http://localhost:7070/kylin/api/user/authentication
-
- Authorization:Basic xxxxJD124xxxGFxxxSDF
- Content-Type: application/json;charset=UTF-8
-```
-
-### 2. Get details of cube.
-* `GET http://localhost:7070/kylin/api/cubes?cubeName={cube_name}&limit=15&offset=0`
-* Client can find cube segment date ranges in returned cube detail.
-* Example
-```
- GET http://localhost:7070/kylin/api/cubes?cubeName=test_kylin_cube_with_slr&limit=15&offset=0
-
- Authorization:Basic xxxxJD124xxxGFxxxSDF
- Content-Type: application/json;charset=UTF-8
-```
-
-### 3. Then submit a build job of the cube.
-* `PUT http://localhost:7070/kylin/api/cubes/{cube_name}/rebuild`
-* For put request body detail please refer to [service doc](https://github.com/KylinOLAP/Kylin/wiki/Restful-Service-Doc).
- * `startTime` and `endTime` should be utc timestamp.
- * `buildType` can be `BUILD` or `MERGE`. `BUILD` is for building a new segment or refreshing an existing segment. `MERGE` is for merging multiple existing segments into one bigger segment.
-* This method will return a newly created job instance, in which the uuid is the identity of job to track job status.
-* Example
-```
- PUT http://localhost:7070/kylin/api/cubes/test_kylin_cube_with_slr/rebuild
-
- Authorization:Basic xxxxJD124xxxGFxxxSDF
- Content-Type: application/json;charset=UTF-8
-
- {
- "startTime": 0,
- "endTime": 1388563200000,
- "buildType": "BUILD"
- }
-```
-
-### 4. Track job status.
-* `GET http://localhost:7070/kylin/api/jobs/{job_uuid}`
-* Returned `job_status` represents current status of job.
-
-### 5. If the job failed, you can resume the job.
-* `PUT http://localhost:7070/kylin/api/jobs/{job_uuid}/resume`
http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/3a5829c7/website/_docs/development/How to consume Kylin REST API in javascript.md
----------------------------------------------------------------------
diff --git a/website/_docs/development/How to consume Kylin REST API in javascript.md b/website/_docs/development/How to consume Kylin REST API in javascript.md
deleted file mode 100644
index a0ea1b6..0000000
--- a/website/_docs/development/How to consume Kylin REST API in javascript.md
+++ /dev/null
@@ -1,42 +0,0 @@
-Kylin securicty authorization is based on basic access authorization, so when you want to use API in your javascript,you need to involve the authorization info in http headers.
-
-
-## Here is a demo show how to use Kylin Query API.
-```
-$.ajaxSetup({
- headers: { 'Authorization': "Basic eWFu**********X***ZA==", 'Content-Type': 'application/json;charset=utf-8' } // use your own authorization code here
- });
- var request = $.ajax({
- url: "http://hostname/kylin/api/query",
- type: "POST",
- data: '{"sql":"select count(*) from SUMMARY;","offset":0,"limit":50000,"partial":true,"project":"test"}',
- dataType: "json"
- });
- request.done(function( msg ) {
- alert(msg);
- });
- request.fail(function( jqXHR, textStatus ) {
- alert( "Request failed: " + textStatus );
- });
-
-```
-
-
-For what is basic access authorization ,click here http://en.wikipedia.org/wiki/Basic_access_authentication
-
-## Keypoint:
-1. add basic access authorization info in heders.
-2. use right ajax type and right data synax
-
-How to generate your authorization code (download and import "jquery.base64.js" from https://github.com/yckart/jquery.base64.js)
-
-```
-var authorizationCode = $.base64('encode', 'NT_USERNAME' + ":" + 'NT_PASSWORD');
-
-$.ajaxSetup({
- headers: {
- 'Authorization': "Basic " + authorizationCode,
- 'Content-Type': 'application/json;charset=utf-8'
- }
-});
-```
\ No newline at end of file