This is an automated email from the ASF dual-hosted git repository.
xxyu pushed a commit to branch doc5.0
in repository https://gitbox.apache.org/repos/asf/kylin.git
The following commit(s) were added to refs/heads/doc5.0 by this push:
new 8736f1c65b Refine kylin5's tutorial
8736f1c65b is described below
commit 8736f1c65bb72762eb011bb534ee230aef01b292
Author: XiaoxiangYu <[email protected]>
AuthorDate: Fri Nov 25 16:54:59 2022 +0800
Refine kylin5's tutorial
---
.../platform/install_on_apache_hadoop.md | 2 +-
.../docs/deployment/on-premises/prerequisite.md | 2 +-
website/docs/intro.md | 26 -----------------
.../model_design/measure_design/collect_set.md | 2 +-
.../measure_design/count_distinct_bitmap.md | 2 +-
.../measure_design/count_distinct_hllc.md | 2 +-
.../measure_design/percentile_approx.md | 2 +-
.../modeling/model_design/measure_design/topn.md | 2 +-
.../quickstart/{quick_start.md => deploy_kylin.md} | 31 +++++++++++++-------
website/docs/quickstart/intro.md | 34 ----------------------
website/docs/quickstart/overview.md | 25 ++++++++++++++++
website/docs/quickstart/sample_dataset.md | 2 +-
.../{expert_mode_tutorial.md => tutorial.md} | 16 +++++-----
website/docusaurus.config.js | 4 +--
website/sidebars.js | 11 ++-----
15 files changed, 66 insertions(+), 97 deletions(-)
diff --git
a/website/docs/deployment/on-premises/installation/platform/install_on_apache_hadoop.md
b/website/docs/deployment/on-premises/installation/platform/install_on_apache_hadoop.md
index 02132bcd80..df05a8739e 100644
---
a/website/docs/deployment/on-premises/installation/platform/install_on_apache_hadoop.md
+++
b/website/docs/deployment/on-premises/installation/platform/install_on_apache_hadoop.md
@@ -49,4 +49,4 @@ Here is a download link for the jar file package of the MySQL
8.0 JDBC driver：
### Install Kylin
-After setting up the environment, please refer to [Quick
Start](docs/quickstart/quick_start.md) to continue.
+After setting up the environment, please refer to [Quick
Start](docs/quickstart/deploy_kylin.md) to continue.
diff --git a/website/docs/deployment/on-premises/prerequisite.md
b/website/docs/deployment/on-premises/prerequisite.md
index a8190cc817..1d1fce2945 100644
--- a/website/docs/deployment/on-premises/prerequisite.md
+++ b/website/docs/deployment/on-premises/prerequisite.md
@@ -5,7 +5,7 @@ sidebar_label: Prerequisite
pagination_label: Prerequisite
toc_min_heading_level: 2
toc_max_heading_level: 6
-pagination_prev: intro
+pagination_prev: null
pagination_next: null
keywords:
- prerequisite
diff --git a/website/docs/intro.md b/website/docs/intro.md
deleted file mode 100644
index d5912693fc..0000000000
--- a/website/docs/intro.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-title: Intro to Kylin 5.0
-language: en
-sidebar_label: Intro to Kylin 5.0
-pagination_label: Intro to Kylin 5.0
-toc_min_heading_level: 2
-toc_max_heading_level: 6
-pagination_prev: null
-pagination_next: null
-keywords:
- - intro
-draft: false
-last_update:
- date: 08/12/2022
----
-
-# Intro to Kylin 5.0
-
-Let's discover ** Kylin 5.0 in than 15 minutes **.
-
-## Getting Started
-
-```shell
-
-docker pull apachekylin/apache-kylin-standalone:5.0.0
-```
diff --git a/website/docs/modeling/model_design/measure_design/collect_set.md
b/website/docs/modeling/model_design/measure_design/collect_set.md
index bda2897bfd..0d84fea2ce 100644
--- a/website/docs/modeling/model_design/measure_design/collect_set.md
+++ b/website/docs/modeling/model_design/measure_design/collect_set.md
@@ -21,7 +21,7 @@ From Kylin 5, Kylin supports the COLLECT_SET function, which
returns a set of un
### Use Case
-Let’s use the project created in the chapter
[Tutorial](../../../quickstart/expert_mode_tutorial.md) as an example to
introduce COLLECT_SET measure settings. This project uses the SSB Dataset and
needs to complete the model design and index build (including data load). A
model won't be able to serve any queries if it has no index and data. You can
read [Model Design Basics](../../data_modeling.md) to understand more about the
methods used in model design.
+Let’s use the project created in the chapter
[Tutorial](../../../quickstart/tutorial.md) as an example to introduce
COLLECT_SET measure settings. This project uses the SSB Dataset and needs to
complete the model design and index build (including data load). A model won't
be able to serve any queries if it has no index and data. You can read [Model
Design Basics](../../data_modeling.md) to understand more about the methods
used in model design.
We will use the fact table `SSB.P_LINEORDER`. This sample table is a mockup of
transactions that can happen in an online marketplace. It has a couple of
dimension and measure columns. For easy understanding, we will only use two
columns: `LO_CUSTKEY` and `LO_ORDERDATE`. The table below gives an introduction
of these columns.
diff --git
a/website/docs/modeling/model_design/measure_design/count_distinct_bitmap.md
b/website/docs/modeling/model_design/measure_design/count_distinct_bitmap.md
index 5646386d9d..4cf6db2be0 100644
--- a/website/docs/modeling/model_design/measure_design/count_distinct_bitmap.md
+++ b/website/docs/modeling/model_design/measure_design/count_distinct_bitmap.md
@@ -29,7 +29,7 @@ Before using the Count Distinct query, you need to clarify if
the target column
### Count Distinct Precision Setting
-Let’s use the project created in the chapter
[Tutorial](../../../quickstart/expert_mode_tutorial.md) as an example to
introduce count distinct precision measure settings. This project uses the SSB
Dataset and needs to complete the model design and index build (including data
load). A model won't be able to serve any queries if it has no index and data.
You can read [Model Design Basics](../../data_modeling.md) to understand more
about the methods used in model design.
+Let’s use the project created in the chapter
[Tutorial](../../../quickstart/tutorial.md) as an example to introduce count
distinct precision measure settings. This project uses the SSB Dataset and
needs to complete the model design and index build (including data load). A
model won't be able to serve any queries if it has no index and data. You can
read [Model Design Basics](../../data_modeling.md) to understand more about the
methods used in model design.
Please add a measure in the model editing page as follows. Please fill in the
measure **Name**, such as `DISTINCT_CUSTOMER`, select **Function** as
**COUNT_DISTINCT**, select accuracy requirement from **Function Parameter**,
and finally select the target column from the drop-down list.
diff --git
a/website/docs/modeling/model_design/measure_design/count_distinct_hllc.md
b/website/docs/modeling/model_design/measure_design/count_distinct_hllc.md
index 5a255df9b2..b1e6625d81 100644
--- a/website/docs/modeling/model_design/measure_design/count_distinct_hllc.md
+++ b/website/docs/modeling/model_design/measure_design/count_distinct_hllc.md
@@ -30,7 +30,7 @@ In the project of Kylin 5, you can customize Count Distinct
(Approximate) measur
### Prerequisite
-Let’s use the project created in the chapter
[Tutorial](../../../quickstart/expert_mode_tutorial.md) as an example to
introduce approximate count distinct measure settings. This project uses the
SSB Dataset and needs to complete the model design and index build (including
data load). A model won't be able to serve any queries if it has no index and
data. You can read [Model Design Basics](../../data_modeling.md) to understand
more about the methods used in model design.
+Let’s use the project created in the chapter
[Tutorial](../../../quickstart/tutorial.md) as an example to introduce
approximate count distinct measure settings. This project uses the SSB Dataset
and needs to complete the model design and index build (including data load). A
model won't be able to serve any queries if it has no index and data. You can
read [Model Design Basics](../../data_modeling.md) to understand more about the
methods used in model design.
Before using Count Distinct query, you need to check the target column is
ready. You can get measure information in the model editing page. If the desire
measure has been pre-calculated on approximate Count Distinct syntax (requires
both `Function` to be count_distinct and `Return Type` to be hllc), then this
measure is ready for Count Distinct querying. Otherwise, you need to add a new
measure Count Distinct (Approximate) first.
diff --git
a/website/docs/modeling/model_design/measure_design/percentile_approx.md
b/website/docs/modeling/model_design/measure_design/percentile_approx.md
index 5673e06f53..d0fcde4b17 100644
--- a/website/docs/modeling/model_design/measure_design/percentile_approx.md
+++ b/website/docs/modeling/model_design/measure_design/percentile_approx.md
@@ -33,7 +33,7 @@ Percentile_approx returns the value of below which a given
percentage of observa
### Use Case
-Let’s use the project created in the chapter
[Tutorial](../../../quickstart/expert_mode_tutorial.md) as an example to
introduce percentile_approx measure settings. This project uses the SSB Dataset
and needs to complete the model design and index build (including data load). A
model won't be able to serve any queries if it has no index and data. You can
read [Model Design Basics](../../data_modeling.md) to understand more about the
methods used in model design.
+Let’s use the project created in the chapter
[Tutorial](../../../quickstart/tutorial.md) as an example to introduce
percentile_approx measure settings. This project uses the SSB Dataset and needs
to complete the model design and index build (including data load). A model
won't be able to serve any queries if it has no index and data. You can read
[Model Design Basics](../../data_modeling.md) to understand more about the
methods used in model design.
We will use the fact table `SSB.P_LINEORDER`. This sample table is a mockup of
transactions that can happen in an online marketplace. It has a couple of
dimension and measure columns. For easy undersatning, we will only use two
columns: `LO_SUPPKEY` and `LO_ORDTOTALPRICE`. The table below gives an
introduction to these columns.
diff --git a/website/docs/modeling/model_design/measure_design/topn.md
b/website/docs/modeling/model_design/measure_design/topn.md
index 8e8cd76b3e..a4ce1236d1 100644
--- a/website/docs/modeling/model_design/measure_design/topn.md
+++ b/website/docs/modeling/model_design/measure_design/topn.md
@@ -29,7 +29,7 @@ In the project of Kylin 5 the Top-N measure is customizable.
### Top-N Query
-Let’s use the project created in the chapter
[Tutorial](../../../quickstart/expert_mode_tutorial.md) as an example to
introduce Top-N measure settings. This project uses the SSB Dataset and needs
to complete the model design and index build (including data load). A model
won't be able to serve any queries if it has no index and data. You can read
[Model Design Basics](../../data_modeling.md) to understand more about the
methods used in model design.
+Let’s use the project created in the chapter
[Tutorial](../../../quickstart/tutorial.md) as an example to introduce Top-N
measure settings. This project uses the SSB Dataset and needs to complete the
model design and index build (including data load). A model won't be able to
serve any queries if it has no index and data. You can read [Model Design
Basics](../../data_modeling.md) to understand more about the methods used in
model design.
We will use the fact table `SSB.P_LINEORDER`. This is a mockup of transactions
that can happen in an online marketplace. It has a couple of dimension and
measure columns. For easy understanding, we use only use four columns:
`LO_ORDERDATE`, `LO_SUPPKEY`, `LO_PARTKEY` and `LO_ORDTOTALPRICE`. The table
below gives an introduction to these columns.
diff --git a/website/docs/quickstart/quick_start.md
b/website/docs/quickstart/deploy_kylin.md
similarity index 91%
rename from website/docs/quickstart/quick_start.md
rename to website/docs/quickstart/deploy_kylin.md
index 797c809dc7..b559ff76bc 100644
--- a/website/docs/quickstart/quick_start.md
+++ b/website/docs/quickstart/deploy_kylin.md
@@ -1,14 +1,14 @@
---
-title: Quick Start
+title: Deploy and Start
language: en
-sidebar_label: Quick Start
-pagination_label: Quick Start
+sidebar_label: Deploy and Start
+pagination_label: Deploy and Start
toc_min_heading_level: 2
toc_max_heading_level: 6
-pagination_prev: null
-pagination_next: null
+pagination_prev: quickstart/overview
+pagination_next: quickstart/tutorial
keywords:
- - quick start
+ - Deploy
draft: false
last_update:
date: 09/13/2022
@@ -18,12 +18,22 @@ In this guide, we will explain how to quickly install and
start Kylin 5.
Before proceeding, please make sure the
[Prerequisite](../deployment/on-premises/prerequisite.md) is met.
+### Pull docker for learning
+
+If we want to learn what new features did Kylin 5 provided, and you only have
a laptop,
+we recommend you to pulling the docker image and check the [standalone image
in dockerhub](https://hub.docker.com/r/apachekylin/apache-kylin-standalone) .
+
+```shell
+docker pull apachekylin/apache-kylin-standalone:5.0.0
+```
+
### <span id="install">Download and Install</span>
1. Get Kylin installation package.
- Please refer to [How To Package](../development/how_to_package.md).
+ Please download official release binary from [Download
Page](../download.md) . <br></br>
+ For developer who want to package from source code, please refer to [How To
Package](../development/how_to_package.md).
2. Decide the installation location and the Linux account to run Kylin. All
the examples below are based on the following assumptions:
@@ -35,7 +45,7 @@ Before proceeding, please make sure the
[Prerequisite](../deployment/on-premises
```shell
cd /usr/local
- tar -zxvf Kylin5.0-Beta-[Version].tar.gz
+ tar -zxvf apache-kylin-[Version].tar.gz
```
The decompressed directory is referred to as **$KYLIN_HOME** or **root
directory**.
@@ -45,8 +55,7 @@ Before proceeding, please make sure the
[Prerequisite](../deployment/on-premises
**Note**:
- + For the production environment, we recommend to setup a dedicated
metastore. You can use PostgreSQL which is shipped with Kylin 5.x.
- + The database name of metastore **must start with an English character**.
+ + For the production environment, we recommend to set up a dedicated
metastore. You can use PostgreSQL or MySQL.
Please refer to the below links for complete steps to install and configure:
@@ -206,7 +215,7 @@ We will be using SSB dataset as the data sample to
introduce Kylin in several se
**Validate Product Functions**
-You can create a sample project and model according to [Expert Mode
Tutorial](expert_mode_tutorial.md). The project should validate basic features
such as source table loading, model creation, index build etc.
+You can create a sample project and model according to [Kylin 5
Tutorial](tutorial.md). The project should validate basic features such as
source table loading, model creation, index build etc.
On the **Data Asset -> Model** page, you should see an example model with some
storage over 0.00 KB, this indicates the data has been loaded for this model.
diff --git a/website/docs/quickstart/intro.md b/website/docs/quickstart/intro.md
deleted file mode 100644
index 1e21792954..0000000000
--- a/website/docs/quickstart/intro.md
+++ /dev/null
@@ -1,34 +0,0 @@
----
-title: Overview of Kylin
-language: en
-sidebar_label: Overview of Kylin
-pagination_label: Overview of Kylin
-toc_min_heading_level: 2
-toc_max_heading_level: 6
-pagination_prev: null
-pagination_next: null
-keywords:
- - intro
- - overview
-draft: false
-last_update:
- date: 09/13/2022
----
-
-Apache Kylin is a leading open source OLAP engine for Big Data capable for
sub-second query latency on trillions of records. Since being created and open
sourced by eBay in 2014, and graduated to Top Level Project of Apache Software
Foundation in 2015, Kylin has quickly be adopted by thousands of organizations
world widely as their critical analytics application for Big Data. Apache Kylin
won Info Word Bossie Awards: The Best Open Source Big Data Tool in the year
2015 and 2016.
-
-Kylin has following key strengths:
-
-- High Performance, Sub-second Query Latency
-- Unified Big Data Warehouse Architecture
-- Seamless Integration with BI tools
-- Comprehensive and Enterprise-ready Capabilities
-
-### Pull docker for learning
-
-If we want to learn what new features did Kylin 5 provided, and you only have
a laptop,
-we recommend you to pulling the docker image and check the [standalone image
in dockerhub](https://hub.docker.com/r/apachekylin/apache-kylin-standalone) .
-
-```shell
-docker pull apachekylin/apache-kylin-standalone:5.0.0
-```
diff --git a/website/docs/quickstart/overview.md
b/website/docs/quickstart/overview.md
new file mode 100644
index 0000000000..30151c3cac
--- /dev/null
+++ b/website/docs/quickstart/overview.md
@@ -0,0 +1,25 @@
+---
+title: Overview of Kylin
+language: en
+sidebar_label: Overview of Kylin
+pagination_label: Overview of Kylin
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: null
+pagination_next: quickstart/deploy_kylin
+keywords:
+ - overview
+draft: false
+last_update:
+ date: 09/13/2022
+---
+
+Apache Kylin is a leading open source OLAP engine for Big Data capable for
sub-second query latency on trillions of records. Since being created and open
sourced by eBay in 2014, and graduated to Top Level Project of Apache Software
Foundation in 2015.
+Kylin has quickly been adopted by thousands of organizations world widely as
their critical analytics application for Big Data.
+
+Kylin has following key strengths:
+
+- High Performance, Sub-second Query Latency
+- Unified Big Data Warehouse Architecture
+- Seamless Integration with BI tools
+- Comprehensive and Enterprise-ready Capabilities
diff --git a/website/docs/quickstart/sample_dataset.md
b/website/docs/quickstart/sample_dataset.md
index 7362728b7a..533f59e061 100755
--- a/website/docs/quickstart/sample_dataset.md
+++ b/website/docs/quickstart/sample_dataset.md
@@ -5,7 +5,7 @@ sidebar_label: Sample dataset
pagination_label: Sample dataset
toc_min_heading_level: 2
toc_max_heading_level: 6
-pagination_prev: null
+pagination_prev: quickstart/tutorial
pagination_next: null
keywords:
- sample dataset
diff --git a/website/docs/quickstart/expert_mode_tutorial.md
b/website/docs/quickstart/tutorial.md
similarity index 96%
rename from website/docs/quickstart/expert_mode_tutorial.md
rename to website/docs/quickstart/tutorial.md
index 0364fde954..b77bb2a2ed 100644
--- a/website/docs/quickstart/expert_mode_tutorial.md
+++ b/website/docs/quickstart/tutorial.md
@@ -1,25 +1,25 @@
---
-title: Expert Mode Tutorial
+title: Kylin 5 Tutorial
language: en
-sidebar_label: Expert Mode Tutorial
-pagination_label: Expert Mode Tutorial
+sidebar_label: Tutorial
+pagination_label: Tutorial
toc_min_heading_level: 2
toc_max_heading_level: 6
-pagination_prev: null
-pagination_next: null
+pagination_prev: quickstart/deploy_kylin
+pagination_next: quickstart/sample_dataset
keywords:
- - expert mode tutorial
+ - tutorial
draft: false
last_update:
date: 09/13/2022
---
-Kylin 5.0 provides which the modeling process dominated by user. In this
section, we will show you how to create and optimize model.
+In this section, we will show you how to create and optimize model.
### <span id="preparation">Preparation</span>
-1. Kylin 5.0 provides one mode: You are able to design your own models to
fulfill your analysis demands and load data for your models. You can design the
index manually and let the system continue to improve the index according your
query habits and data characteristics.
+1. You are able to design your own models to fulfill your analysis demands and
load data for your models. You can design the index manually and let the system
continue to improve the index according your query habits and data
characteristics.
2. We will use the SSB (Star Schema Benchmark) sample data to introduce the
project. You can find out how to import the sample data in the [Import Data
from Hive](../datasource/import_hive.md) section.
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
index 05d5702ef2..e4983c888b 100644
--- a/website/docusaurus.config.js
+++ b/website/docusaurus.config.js
@@ -142,7 +142,7 @@ const config = {
items: [
{
type: 'doc',
- docId: 'quickstart/intro',
+ docId: 'quickstart/overview',
position: 'left',
label: 'Document',
},
@@ -187,7 +187,7 @@ const config = {
items: [
{
label: 'Quick Start',
- to: '/docs/quickstart/quick_start',
+ to: '/docs/quickstart/tutorial',
},
{
label: 'How to write this doc',
diff --git a/website/sidebars.js b/website/sidebars.js
index 629099215a..0511fe27d8 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -21,26 +21,21 @@ const sidebars = {
},
],
DocumentSideBar: [
- {
- type: 'doc',
- id: 'intro',
- label: 'Introduction to Kylin 5'
- },
{
type: 'category',
label: 'Quick Start',
link: {
type: 'doc',
- id: 'quickstart/intro',
+ id: 'quickstart/overview',
},
items: [
{
type: 'doc',
- id: 'quickstart/quick_start',
+ id: 'quickstart/deploy_kylin',
},
{
type: 'doc',
- id: 'quickstart/expert_mode_tutorial',
+ id: 'quickstart/tutorial',
},
{
type: 'doc',
