You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by xx...@apache.org on 2022/08/17 05:26:38 UTC
[kylin] 04/07: KYLIN-5221 minor adapt for sidebars and date in doc metadata
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
commit b9cfe7db020fe7f2224ab82dcb4bd3288c4fb160
Author: Mukvin <bo...@163.com>
AuthorDate: Tue Aug 16 14:38:12 2022 +0800
KYLIN-5221 minor adapt for sidebars and date in doc metadata
---
.../On-Premises/deploy_mode/cluster_deployment.md | 2 +-
.../deployment/On-Premises/deploy_mode/intro.md | 2 +-
.../On-Premises/deploy_mode/rw_separation.md | 2 +-
.../On-Premises/deploy_mode/service_discovery.md | 2 +-
.../On-Premises/network_port_requirements.md | 2 +-
.../docs/deployment/On-Premises/prerequisite.md | 2 +-
.../On-Premises/rdbms_metastore/intro.md | 2 +-
.../rdbms_metastore/mysql/install_mysql.md | 2 +-
.../On-Premises/rdbms_metastore/mysql/intro.md | 2 +-
.../rdbms_metastore/mysql/mysql_metastore.md | 2 +-
.../postgresql/default_metastore.md | 2 +-
.../postgresql/install_postgresql.md | 2 +-
.../rdbms_metastore/postgresql/intro.md | 2 +-
website/docs/development/intro.md | 2 +-
website/docs/intro.md | 4 +-
website/docs/modeling/intro.md | 2 +-
website/docs/operations/intro.md | 2 +-
.../operations/monitoring/influxdb/influxdb.md | 2 +-
.../monitoring/influxdb/influxdb_maintenance.md | 2 +-
.../docs/operations/monitoring/influxdb/intro.md | 2 +-
website/docs/operations/monitoring/intro.md | 2 +-
.../docs/operations/monitoring/metrics_intro.md | 2 +-
website/docs/operations/monitoring/service.md | 2 +-
website/docs/restapi/acl_api/acl_api.md | 2 +-
website/docs/restapi/acl_api/intro.md | 2 +-
website/docs/restapi/acl_api/project_acl_api.md | 2 +-
website/docs/restapi/acl_api/user_api.md | 2 +-
website/docs/restapi/acl_api/user_group_api.md | 2 +-
website/docs/restapi/async_query_api.md | 2 +-
website/docs/restapi/authentication.md | 2 +-
website/docs/restapi/callback_api.md | 2 +-
website/docs/restapi/data_source_api.md | 2 +-
website/docs/restapi/error_code.md | 2 +-
website/docs/restapi/intro.md | 2 +-
website/docs/restapi/job_api.md | 2 +-
website/docs/restapi/model_api/intro.md | 2 +-
website/docs/restapi/model_api/model_build_api.md | 2 +-
.../model_api/model_import_and_export_api.md | 2 +-
.../docs/restapi/model_api/model_management_api.md | 2 +-
.../model_api/model_multilevel_partitioning_api.md | 2 +-
website/docs/restapi/project_api.md | 2 +-
website/docs/restapi/query_api.md | 2 +-
website/docs/restapi/segment_managment_api.md | 2 +-
website/docs/restapi/snapshot_management_api.md | 2 +-
website/docs/restapi/streaming_job_api.md | 2 +-
website/sidebars.js | 696 +++++++++++----------
46 files changed, 395 insertions(+), 393 deletions(-)
diff --git a/website/docs/deployment/On-Premises/deploy_mode/cluster_deployment.md b/website/docs/deployment/On-Premises/deploy_mode/cluster_deployment.md
index 18b5d4b0ae..233edb3b6e 100644
--- a/website/docs/deployment/On-Premises/deploy_mode/cluster_deployment.md
+++ b/website/docs/deployment/On-Premises/deploy_mode/cluster_deployment.md
@@ -12,7 +12,7 @@ keywords:
- cluster
draft: true
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
All Kylin state information instance is stored in a RDBMS database, so running Kylin on multiple nodes in a cluster is good practice for better load balance and higher availability. Currently, we only support deployment with one `all` node and multiple `query` nodes.
diff --git a/website/docs/deployment/On-Premises/deploy_mode/intro.md b/website/docs/deployment/On-Premises/deploy_mode/intro.md
index 27ef9f3b86..374f4a4c93 100644
--- a/website/docs/deployment/On-Premises/deploy_mode/intro.md
+++ b/website/docs/deployment/On-Premises/deploy_mode/intro.md
@@ -11,7 +11,7 @@ keywords:
- deployment mode
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
This chapter introduces the different Kylin deployment modes and options to achieve high performance, high stability, and high availability.
diff --git a/website/docs/deployment/On-Premises/deploy_mode/rw_separation.md b/website/docs/deployment/On-Premises/deploy_mode/rw_separation.md
index 2f2dbb1fc1..e36724f586 100644
--- a/website/docs/deployment/On-Premises/deploy_mode/rw_separation.md
+++ b/website/docs/deployment/On-Premises/deploy_mode/rw_separation.md
@@ -12,7 +12,7 @@ keywords:
- separation
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
Kylin's tasks based on Hadoop are mainly divided into two types: build and query. If these two tasks use the same set of Hadoop resources, resource preemption may occur between the build and the query, which makes them not stable and fast.
diff --git a/website/docs/deployment/On-Premises/deploy_mode/service_discovery.md b/website/docs/deployment/On-Premises/deploy_mode/service_discovery.md
index a08758deff..0015f85ae6 100644
--- a/website/docs/deployment/On-Premises/deploy_mode/service_discovery.md
+++ b/website/docs/deployment/On-Premises/deploy_mode/service_discovery.md
@@ -12,7 +12,7 @@ keywords:
- ha
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
Multiple Kylin instances can work together as a cluster. When a Kylin instance is started, stopped, or lost, other instances in the cluster will be updated automatically. Kylin has a new implementation based on Apache Curator framework, which is more convenient and more stable.
diff --git a/website/docs/deployment/On-Premises/network_port_requirements.md b/website/docs/deployment/On-Premises/network_port_requirements.md
index 55e04ebf7c..5d409ec903 100644
--- a/website/docs/deployment/On-Premises/network_port_requirements.md
+++ b/website/docs/deployment/On-Premises/network_port_requirements.md
@@ -11,7 +11,7 @@ keywords:
- Network Port
draft: false
last_update:
- date: 11/08/2022
+ date: 08/11/2022
---
Kylin needs to communicate with different components. The following are the ports that need to be opened to Kylin. This table only includes the default configuration of the Hadoop environment, and does not include the configuration differences between Hadoop platforms.
diff --git a/website/docs/deployment/On-Premises/prerequisite.md b/website/docs/deployment/On-Premises/prerequisite.md
index 684188db59..7285b35bed 100644
--- a/website/docs/deployment/On-Premises/prerequisite.md
+++ b/website/docs/deployment/On-Premises/prerequisite.md
@@ -11,7 +11,7 @@ keywords:
- prerequisite
draft: true
last_update:
- date: 11/08/2022
+ date: 08/11/2022
---
To ensure system performance and stability, we recommend you run Kylin on a dedicated Hadoop cluster.
diff --git a/website/docs/deployment/On-Premises/rdbms_metastore/intro.md b/website/docs/deployment/On-Premises/rdbms_metastore/intro.md
index fd217647e3..d8e679ac2a 100644
--- a/website/docs/deployment/On-Premises/rdbms_metastore/intro.md
+++ b/website/docs/deployment/On-Premises/rdbms_metastore/intro.md
@@ -11,7 +11,7 @@ keywords:
- Use RDBMS as Metastore
draft: false
last_update:
- date: 11/08/2022
+ date: 08/11/2022
---
Using RDBMS as Metastore is supported, which uses JDBC Driver to connect Metastore database.
diff --git a/website/docs/deployment/On-Premises/rdbms_metastore/mysql/install_mysql.md b/website/docs/deployment/On-Premises/rdbms_metastore/mysql/install_mysql.md
index d3464debea..c65ddc2269 100644
--- a/website/docs/deployment/On-Premises/rdbms_metastore/mysql/install_mysql.md
+++ b/website/docs/deployment/On-Premises/rdbms_metastore/mysql/install_mysql.md
@@ -13,7 +13,7 @@ keywords:
- install
draft: true
last_update:
- date: 11/08/2022
+ date: 08/11/2022
---
### Prerequisite
diff --git a/website/docs/deployment/On-Premises/rdbms_metastore/mysql/intro.md b/website/docs/deployment/On-Premises/rdbms_metastore/mysql/intro.md
index fd0cf7a152..58f097b972 100644
--- a/website/docs/deployment/On-Premises/rdbms_metastore/mysql/intro.md
+++ b/website/docs/deployment/On-Premises/rdbms_metastore/mysql/intro.md
@@ -11,7 +11,7 @@ keywords:
- mysql
draft: false
last_update:
- date: 11/08/2022
+ date: 08/11/2022
---
Kylin supports to use MySQL as Metastore, this chapter will discuss how to:
diff --git a/website/docs/deployment/On-Premises/rdbms_metastore/mysql/mysql_metastore.md b/website/docs/deployment/On-Premises/rdbms_metastore/mysql/mysql_metastore.md
index 408edf4ceb..6f9a666365 100644
--- a/website/docs/deployment/On-Premises/rdbms_metastore/mysql/mysql_metastore.md
+++ b/website/docs/deployment/On-Premises/rdbms_metastore/mysql/mysql_metastore.md
@@ -13,7 +13,7 @@ keywords:
- metastore
draft: false
last_update:
- date: 11/08/2022
+ date: 08/11/2022
---
diff --git a/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/default_metastore.md b/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/default_metastore.md
index 43e71ae44f..f801a18f90 100644
--- a/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/default_metastore.md
+++ b/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/default_metastore.md
@@ -11,7 +11,7 @@ keywords:
- postgresql
draft: false
last_update:
- date: 11/08/2022
+ date: 08/11/2022
---
### <span id="preparation">Prerequisite</span>
diff --git a/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/install_postgresql.md b/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/install_postgresql.md
index 17d47f61d8..6d0acf19e4 100644
--- a/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/install_postgresql.md
+++ b/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/install_postgresql.md
@@ -11,7 +11,7 @@ keywords:
- mysql
draft: true
last_update:
- date: 11/08/2022
+ date: 08/11/2022
---
### <span id="preparation">Prerequisite</span>
diff --git a/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/intro.md b/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/intro.md
index b84ad6905a..6d433b8776 100644
--- a/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/intro.md
+++ b/website/docs/deployment/On-Premises/rdbms_metastore/postgresql/intro.md
@@ -11,7 +11,7 @@ keywords:
- postgresql
draft: false
last_update:
- date: 11/08/2022
+ date: 08/11/2022
---
Kylin supports to use PostgreSQL as Metastore, this chapter will discuss how to:
diff --git a/website/docs/development/intro.md b/website/docs/development/intro.md
index d4597f0c27..e3f236c1ed 100644
--- a/website/docs/development/intro.md
+++ b/website/docs/development/intro.md
@@ -11,6 +11,6 @@ keywords:
- deployment mode
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
# Guide of developer
diff --git a/website/docs/intro.md b/website/docs/intro.md
index e17893a55f..d5912693fc 100644
--- a/website/docs/intro.md
+++ b/website/docs/intro.md
@@ -8,10 +8,10 @@ toc_max_heading_level: 6
pagination_prev: null
pagination_next: null
keywords:
- - rest api
+ - intro
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
# Intro to Kylin 5.0
diff --git a/website/docs/modeling/intro.md b/website/docs/modeling/intro.md
index 533404ab92..c624427c4e 100644
--- a/website/docs/modeling/intro.md
+++ b/website/docs/modeling/intro.md
@@ -11,7 +11,7 @@ keywords:
- model
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
This chapter introduces the core concepts of Kylin: model and index design basics, advanced measures and load data.
diff --git a/website/docs/operations/intro.md b/website/docs/operations/intro.md
index e8feeac788..e75d44f3bf 100644
--- a/website/docs/operations/intro.md
+++ b/website/docs/operations/intro.md
@@ -12,7 +12,7 @@ keywords:
- maintenance
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
This Operation and Maintenance Guide will introduce a suite of capabilities that can help you to manage your Kylin projects, do system maintenance, work with logs.
diff --git a/website/docs/operations/monitoring/influxdb/influxdb.md b/website/docs/operations/monitoring/influxdb/influxdb.md
index d0636f0f64..efc00a2782 100644
--- a/website/docs/operations/monitoring/influxdb/influxdb.md
+++ b/website/docs/operations/monitoring/influxdb/influxdb.md
@@ -11,7 +11,7 @@ keywords:
- influxdb
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
diff --git a/website/docs/operations/monitoring/influxdb/influxdb_maintenance.md b/website/docs/operations/monitoring/influxdb/influxdb_maintenance.md
index 632a6c675d..9cc609194c 100644
--- a/website/docs/operations/monitoring/influxdb/influxdb_maintenance.md
+++ b/website/docs/operations/monitoring/influxdb/influxdb_maintenance.md
@@ -11,7 +11,7 @@ keywords:
- influxdb
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
diff --git a/website/docs/operations/monitoring/influxdb/intro.md b/website/docs/operations/monitoring/influxdb/intro.md
index 96ea606197..f3d5f8934e 100644
--- a/website/docs/operations/monitoring/influxdb/intro.md
+++ b/website/docs/operations/monitoring/influxdb/intro.md
@@ -12,7 +12,7 @@ keywords:
- maintenance
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
Kylin supports to use InfluxDB as its time series database, this chapter will cover:
diff --git a/website/docs/operations/monitoring/intro.md b/website/docs/operations/monitoring/intro.md
index 2d2d302d57..8506f7f158 100644
--- a/website/docs/operations/monitoring/intro.md
+++ b/website/docs/operations/monitoring/intro.md
@@ -12,7 +12,7 @@ keywords:
- maintenance
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
This chapter will discuss how to do system monitoring, we will cover:
diff --git a/website/docs/operations/monitoring/metrics_intro.md b/website/docs/operations/monitoring/metrics_intro.md
index cee36b3265..fc7bc1a0a1 100644
--- a/website/docs/operations/monitoring/metrics_intro.md
+++ b/website/docs/operations/monitoring/metrics_intro.md
@@ -11,7 +11,7 @@ keywords:
- metrics monitoring
draft: true
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
diff --git a/website/docs/operations/monitoring/service.md b/website/docs/operations/monitoring/service.md
index d1194457cf..586ac0409b 100644
--- a/website/docs/operations/monitoring/service.md
+++ b/website/docs/operations/monitoring/service.md
@@ -11,7 +11,7 @@ keywords:
- service monitoring
draft: true
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
## Service Monitoring
diff --git a/website/docs/restapi/acl_api/acl_api.md b/website/docs/restapi/acl_api/acl_api.md
index 12e444baf4..0e2e95665f 100644
--- a/website/docs/restapi/acl_api/acl_api.md
+++ b/website/docs/restapi/acl_api/acl_api.md
@@ -11,7 +11,7 @@ keywords:
- data acl api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
> Reminders:
diff --git a/website/docs/restapi/acl_api/intro.md b/website/docs/restapi/acl_api/intro.md
index 2def65af7e..dff7e6148f 100644
--- a/website/docs/restapi/acl_api/intro.md
+++ b/website/docs/restapi/acl_api/intro.md
@@ -11,7 +11,7 @@ keywords:
- acl management api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
Kylin provides REST APIs on Access Control List Management to help users strictly manage the ACL on projects, tables, users, user group and so on.
diff --git a/website/docs/restapi/acl_api/project_acl_api.md b/website/docs/restapi/acl_api/project_acl_api.md
index 14aa630b52..1d34c3063e 100644
--- a/website/docs/restapi/acl_api/project_acl_api.md
+++ b/website/docs/restapi/acl_api/project_acl_api.md
@@ -11,7 +11,7 @@ keywords:
- project acl api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
> Reminders:
diff --git a/website/docs/restapi/acl_api/user_api.md b/website/docs/restapi/acl_api/user_api.md
index 3fb7fe77e9..45f1995561 100644
--- a/website/docs/restapi/acl_api/user_api.md
+++ b/website/docs/restapi/acl_api/user_api.md
@@ -11,7 +11,7 @@ keywords:
- user management api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
> Reminders:
diff --git a/website/docs/restapi/acl_api/user_group_api.md b/website/docs/restapi/acl_api/user_group_api.md
index 97f01a0d03..bb4846e15a 100644
--- a/website/docs/restapi/acl_api/user_group_api.md
+++ b/website/docs/restapi/acl_api/user_group_api.md
@@ -11,7 +11,7 @@ keywords:
- user group management api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
diff --git a/website/docs/restapi/async_query_api.md b/website/docs/restapi/async_query_api.md
index 818f76f3e2..e297b20e32 100644
--- a/website/docs/restapi/async_query_api.md
+++ b/website/docs/restapi/async_query_api.md
@@ -11,7 +11,7 @@ keywords:
- async query api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
> Reminders:
diff --git a/website/docs/restapi/authentication.md b/website/docs/restapi/authentication.md
index 5562d5c780..b1fe66aa0f 100644
--- a/website/docs/restapi/authentication.md
+++ b/website/docs/restapi/authentication.md
@@ -12,7 +12,7 @@ keywords:
- authentication
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
### Access Information
diff --git a/website/docs/restapi/callback_api.md b/website/docs/restapi/callback_api.md
index c8e5be8fd1..66bfcda8f1 100644
--- a/website/docs/restapi/callback_api.md
+++ b/website/docs/restapi/callback_api.md
@@ -12,7 +12,7 @@ keywords:
- monitor job
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
The success returned by calling the required job API only indicates the job is successfully started. Kylin supports callback API to confirm the job execution state, it will return success if the job is successfully completed; it will return error if the job fails and also the error code to help troubleshooting.
diff --git a/website/docs/restapi/data_source_api.md b/website/docs/restapi/data_source_api.md
index e53ac925bc..598d9b0a6c 100644
--- a/website/docs/restapi/data_source_api.md
+++ b/website/docs/restapi/data_source_api.md
@@ -11,7 +11,7 @@ keywords:
- data source api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
> Reminder:
diff --git a/website/docs/restapi/error_code.md b/website/docs/restapi/error_code.md
index 198241237c..9231d819bb 100644
--- a/website/docs/restapi/error_code.md
+++ b/website/docs/restapi/error_code.md
@@ -11,7 +11,7 @@ keywords:
- error code
draft: true
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
[comment]: <#TODO: renew the error code> (#TODO)
diff --git a/website/docs/restapi/intro.md b/website/docs/restapi/intro.md
index cc09056c66..89abd892d1 100644
--- a/website/docs/restapi/intro.md
+++ b/website/docs/restapi/intro.md
@@ -11,7 +11,7 @@ keywords:
- rest api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
Kylin provides various REST APIs, which can be used to execute queries, trigger a build job and so on. With those APIs, the third-party system could integrate with Kylin system seamlessly.
diff --git a/website/docs/restapi/job_api.md b/website/docs/restapi/job_api.md
index 9fbcf8472b..43f6843145 100644
--- a/website/docs/restapi/job_api.md
+++ b/website/docs/restapi/job_api.md
@@ -11,7 +11,7 @@ keywords:
- job api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
diff --git a/website/docs/restapi/model_api/intro.md b/website/docs/restapi/model_api/intro.md
index 0f49e728ff..966c869d88 100644
--- a/website/docs/restapi/model_api/intro.md
+++ b/website/docs/restapi/model_api/intro.md
@@ -11,7 +11,7 @@ keywords:
- model api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
diff --git a/website/docs/restapi/model_api/model_build_api.md b/website/docs/restapi/model_api/model_build_api.md
index 90a30648f0..95f0de1959 100644
--- a/website/docs/restapi/model_api/model_build_api.md
+++ b/website/docs/restapi/model_api/model_build_api.md
@@ -11,7 +11,7 @@ keywords:
- model build api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
diff --git a/website/docs/restapi/model_api/model_import_and_export_api.md b/website/docs/restapi/model_api/model_import_and_export_api.md
index 277183860c..830dead62d 100644
--- a/website/docs/restapi/model_api/model_import_and_export_api.md
+++ b/website/docs/restapi/model_api/model_import_and_export_api.md
@@ -11,7 +11,7 @@ keywords:
- model import and export api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
diff --git a/website/docs/restapi/model_api/model_management_api.md b/website/docs/restapi/model_api/model_management_api.md
index 7d0b4352a1..93757f8a99 100644
--- a/website/docs/restapi/model_api/model_management_api.md
+++ b/website/docs/restapi/model_api/model_management_api.md
@@ -11,7 +11,7 @@ keywords:
- model management api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
diff --git a/website/docs/restapi/model_api/model_multilevel_partitioning_api.md b/website/docs/restapi/model_api/model_multilevel_partitioning_api.md
index 0af956b037..9bb5043a13 100644
--- a/website/docs/restapi/model_api/model_multilevel_partitioning_api.md
+++ b/website/docs/restapi/model_api/model_multilevel_partitioning_api.md
@@ -11,7 +11,7 @@ keywords:
- multi-level partitioning model api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
> Reminders:
diff --git a/website/docs/restapi/project_api.md b/website/docs/restapi/project_api.md
index 15fc80476b..433d1cff9c 100644
--- a/website/docs/restapi/project_api.md
+++ b/website/docs/restapi/project_api.md
@@ -11,7 +11,7 @@ keywords:
- project setting api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
diff --git a/website/docs/restapi/query_api.md b/website/docs/restapi/query_api.md
index 44813e2c18..1615afe456 100755
--- a/website/docs/restapi/query_api.md
+++ b/website/docs/restapi/query_api.md
@@ -11,7 +11,7 @@ keywords:
- query api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
> Reminders:
diff --git a/website/docs/restapi/segment_managment_api.md b/website/docs/restapi/segment_managment_api.md
index 8d3c0ea037..b63b008248 100644
--- a/website/docs/restapi/segment_managment_api.md
+++ b/website/docs/restapi/segment_managment_api.md
@@ -11,7 +11,7 @@ keywords:
- segment management api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
> Reminders:
diff --git a/website/docs/restapi/snapshot_management_api.md b/website/docs/restapi/snapshot_management_api.md
index a20fb44753..329cf09c43 100644
--- a/website/docs/restapi/snapshot_management_api.md
+++ b/website/docs/restapi/snapshot_management_api.md
@@ -11,7 +11,7 @@ keywords:
- snapshot management api
draft: false
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
> Note:
diff --git a/website/docs/restapi/streaming_job_api.md b/website/docs/restapi/streaming_job_api.md
index e8da883e79..3cd23d6686 100644
--- a/website/docs/restapi/streaming_job_api.md
+++ b/website/docs/restapi/streaming_job_api.md
@@ -11,7 +11,7 @@ keywords:
- streaming job api
draft: true
last_update:
- date: 12/08/2022
+ date: 08/12/2022
---
> Reminders:
diff --git a/website/sidebars.js b/website/sidebars.js
index dfe3ede545..37f85b5db4 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -13,354 +13,356 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
- // By default, Docusaurus generates a sidebar from the docs folder structure
- KylinDocumentSideBar:[
- {
- type: 'doc',
- id: 'intro',
- label: 'Introduction to Kylin 5'
- },
- {
- type: 'doc',
- id: 'download',
- label: 'Download',
- },
- {
- type: 'category',
- label: 'Tutorial',
+ // By default, Docusaurus generates a sidebar from the docs folder structure
+ DownloadSideBar: [
+ {
+ type: 'doc',
+ id: 'download',
+ label: 'Download',
+ },
+ ],
+ DocumentSideBar: [
+ {
+ type: 'doc',
+ id: 'intro',
+ label: 'Introduction to Kylin 5'
+ },
+ {
+ type: 'category',
+ label: 'Tutorial',
- items: [
- {
- type: 'doc',
- id: 'tutorial/create-a-page'
- },
- {
- type: 'doc',
- id: 'tutorial/create-a-document'
- },
- {
- type: 'doc',
- id: 'tutorial/create-a-blog-post'
- },
- {
- type: 'doc',
- id: 'tutorial/deploy-your-site'
- },
- ]
- },
- {
- type: 'category',
- label: 'Deployment',
- items: [
- {
- type: 'doc',
- id: 'deployment/intro'
- },
- {
- type: 'category',
- label: 'On-Premises',
- items: [
- {
- type: 'doc',
- id: 'deployment/On-Premises/prerequisite'
- },
- {
- type: 'doc',
- id: 'deployment/On-Premises/network_port_requirements'
- },
- {
- type: 'category',
- label: 'Use RDBMS as Metastore',
- link: {
- type: 'doc',
- id: 'deployment/On-Premises/rdbms_metastore/intro',
- },
- items: [
- {
- type: 'category',
- label: 'MySQL',
- link: {
- type: 'doc',
- id: 'deployment/On-Premises/rdbms_metastore/mysql/intro',
- },
- items: [
- {
- type: 'doc',
- id: 'deployment/On-Premises/rdbms_metastore/mysql/install_mysql'
- },
- {
- type: 'doc',
- id: 'deployment/On-Premises/rdbms_metastore/mysql/mysql_metastore'
- },
- ],
- },
- {
- type: 'category',
- label: 'PostgreSQL',
- link: {
- type: 'doc',
- id: 'deployment/On-Premises/rdbms_metastore/postgresql/intro',
- },
- items: [
- {
- type: 'doc',
- id: 'deployment/On-Premises/rdbms_metastore/postgresql/install_postgresql'
- },
- {
- type: 'doc',
- id: 'deployment/On-Premises/rdbms_metastore/postgresql/default_metastore'
- },
- ],
- },
- ]
- },
- {
- type: 'category',
- label: 'Deployment Mode',
- link: {
- type: 'doc',
- id: 'deployment/On-Premises/deploy_mode/intro',
- },
- items: [
- {
- type: 'doc',
- id: 'deployment/On-Premises/deploy_mode/cluster_deployment'
- },
- {
- type: 'doc',
- id: 'deployment/On-Premises/deploy_mode/service_discovery'
- },
- {
- type: 'doc',
- id: 'deployment/On-Premises/deploy_mode/rw_separation'
- },
- ]
- }
- ]
- },
- {
- type: 'category',
- label: 'On-Cloud',
- items: [
- {
- type: 'doc',
- id: 'deployment/On-Cloud/intro'
- }
- ]
- }
- ],
- },
- {
- type: 'category',
- label: 'Modeling',
- items: [
- {
- type: 'doc',
- id: 'modeling/intro'
- },
- ],
- },
- {
- type: 'category',
- label: 'Rest API',
- link: {
- type: 'doc',
- id: 'restapi/intro',
- },
- items: [
- {
- type: 'doc',
- id: 'restapi/authentication'
- },
- {
- type: 'doc',
- id: 'restapi/project_api'
- },
- {
- type: 'category',
- label: 'Model API',
- link: {
- type: 'doc',
- id: 'restapi/model_api/intro',
- },
- items: [
- {
- type: 'doc',
- id: 'restapi/model_api/model_management_api'
- },
- {
- type: 'doc',
- id: 'restapi/model_api/model_build_api'
- },
- {
- type: 'doc',
- id: 'restapi/model_api/model_import_and_export_api'
- },
- {
- type: 'doc',
- id: 'restapi/model_api/model_multilevel_partitioning_api'
- },
- ],
- },
- {
- type: 'doc',
- id: 'restapi/segment_managment_api'
- },
- {
- type: 'doc',
- id: 'restapi/snapshot_management_api'
- },
- {
- type: 'doc',
- id: 'restapi/query_api'
- },
- {
- type: 'doc',
- id: 'restapi/data_source_api'
- },
- {
- type: 'doc',
- id: 'restapi/async_query_api'
- },
- {
- type: 'doc',
- id: 'restapi/job_api'
- },
- {
- type: 'category',
- label: 'ACL Management API',
- link: {
- type: 'doc',
- id: 'restapi/acl_api/intro',
- },
- items: [
- {
- type: 'doc',
- id: 'restapi/acl_api/user_api'
- },
- {
- type: 'doc',
- id: 'restapi/acl_api/user_group_api'
- },
- {
- type: 'doc',
- id: 'restapi/acl_api/project_acl_api'
- },
- {
- type: 'doc',
- id: 'restapi/acl_api/acl_api'
- },
- ],
- },
- {
- type: 'doc',
- id: 'restapi/streaming_job_api'
- },
- {
- type: 'doc',
- id: 'restapi/callback_api'
- },
- {
- type: 'doc',
- id: 'restapi/error_code'
- },
- ],
- },
- {
- type: 'category',
- label: 'Query',
- items: [
- {
- type: 'doc',
- id: 'query/intro'
- },
- ],
- },
- {
- type: 'category',
- label: 'Operation and Maintenance Guide',
- link: {
- type: 'doc',
- id: 'operations/intro',
- },
- items: [
- {
- type: 'category',
- label: 'Monitoring',
- link: {
- type: 'doc',
- id: 'operations/monitoring/intro',
- },
- items: [
- {
- type: 'category',
- label: 'InfluxDB',
- link: {
- type: 'doc',
- id: 'operations/monitoring/influxdb/intro',
- },
- items: [
- {
- type: 'doc',
- id: 'operations/monitoring/influxdb/influxdb'
- },
- {
- type: 'doc',
- id: 'operations/monitoring/influxdb/influxdb_maintenance'
- },
- ],
- },
- ],
- },
- ],
- },
- {
- type: 'category',
- label: 'Configuration Guide',
- items: [
- {
- type: 'doc',
- id: 'configuration/intro'
- },
- ],
- },
- {
- type: 'category',
- label: 'Development Guide',
- items: [
- {
- type: 'doc',
- id: 'development/roadmap'
- },
- {
- type: 'doc',
- id: 'development/how_to_contribute'
- },
- {
- type: 'doc',
- id: 'development/how_to_debug'
- },
- {
- type: 'doc',
- id: 'development/how_to_package'
- },
- {
- type: 'doc',
- id: 'development/how_to_release'
- },
- ],
- },
- {
- type: 'doc',
- id: 'community',
- label: 'Community',
- },
- {
- type: 'doc',
- id: 'powerBy',
- label: 'PowerBy',
- }
- ],
+ items: [
+ {
+ type: 'doc',
+ id: 'tutorial/create-a-page'
+ },
+ {
+ type: 'doc',
+ id: 'tutorial/create-a-document'
+ },
+ {
+ type: 'doc',
+ id: 'tutorial/create-a-blog-post'
+ },
+ {
+ type: 'doc',
+ id: 'tutorial/deploy-your-site'
+ },
+ ]
+ },
+ {
+ type: 'category',
+ label: 'Deployment',
+ items: [
+ {
+ type: 'doc',
+ id: 'deployment/intro'
+ },
+ {
+ type: 'doc',
+ id: 'deployment/prerequisite'
+ },
+ {
+ type: 'doc',
+ id: 'deployment/network_port_requirements'
+ },
+ // TODO: add Installation part
+ // {
+ // type: 'category',
+ // label: 'Installation',
+ // items:[
+ // {
+ //
+ // },
+ // ],
+ // },
+ {
+ type: 'category',
+ label: 'Use RDBMS as Metastore',
+ link: {
+ type: 'doc',
+ id: 'deployment/rdbms_metastore/intro',
+ },
+ items: [
+ {
+ type: 'category',
+ label: 'MySQL',
+ link: {
+ type: 'doc',
+ id: 'deployment/rdbms_metastore/mysql/intro',
+ },
+ items: [
+ {
+ type: 'doc',
+ id: 'deployment/rdbms_metastore/mysql/install_mysql'
+ },
+ {
+ type: 'doc',
+ id: 'deployment/rdbms_metastore/mysql/mysql_metastore'
+ },
+ ],
+ },
+ {
+ type: 'category',
+ label: 'PostgreSQL',
+ link: {
+ type: 'doc',
+ id: 'deployment/rdbms_metastore/postgresql/intro',
+ },
+ items: [
+ {
+ type: 'doc',
+ id: 'deployment/rdbms_metastore/postgresql/install_postgresql'
+ },
+ {
+ type: 'doc',
+ id: 'deployment/rdbms_metastore/postgresql/default_metastore'
+ },
+ ],
+ },
+ ]
+ },
+ {
+ type: 'category',
+ label: 'Deployment Mode',
+ link: {
+ type: 'doc',
+ id: 'deployment/deploy_mode/intro',
+ },
+ items: [
+ {
+ type: 'doc',
+ id: 'deployment/deploy_mode/cluster_deployment'
+ },
+ {
+ type: 'doc',
+ id: 'deployment/deploy_mode/service_discovery'
+ },
+ {
+ type: 'doc',
+ id: 'deployment/deploy_mode/rw_separation'
+ },
+ ]
+ }
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Modeling',
+ items: [
+ {
+ type: 'doc',
+ id: 'modeling/intro'
+ },
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Rest API',
+ link: {
+ type: 'doc',
+ id: 'restapi/intro',
+ },
+ items: [
+ {
+ type: 'doc',
+ id: 'restapi/authentication'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/project_api'
+ },
+ {
+ type: 'category',
+ label: 'Model API',
+ link: {
+ type: 'doc',
+ id: 'restapi/model_api/intro',
+ },
+ items: [
+ {
+ type: 'doc',
+ id: 'restapi/model_api/model_management_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/model_api/model_build_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/model_api/model_import_and_export_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/model_api/model_multilevel_partitioning_api'
+ },
+ ],
+ },
+ {
+ type: 'doc',
+ id: 'restapi/segment_managment_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/snapshot_management_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/query_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/data_source_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/async_query_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/job_api'
+ },
+ {
+ type: 'category',
+ label: 'ACL Management API',
+ link: {
+ type: 'doc',
+ id: 'restapi/acl_api/intro',
+ },
+ items: [
+ {
+ type: 'doc',
+ id: 'restapi/acl_api/user_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/acl_api/user_group_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/acl_api/project_acl_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/acl_api/acl_api'
+ },
+ ],
+ },
+ {
+ type: 'doc',
+ id: 'restapi/streaming_job_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/callback_api'
+ },
+ {
+ type: 'doc',
+ id: 'restapi/error_code'
+ },
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Query',
+ items: [
+ {
+ type: 'doc',
+ id: 'query/intro'
+ },
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Operation and Maintenance Guide',
+ link: {
+ type: 'doc',
+ id: 'operations/intro',
+ },
+ items: [
+ {
+ type: 'category',
+ label: 'Monitoring',
+ link: {
+ type: 'doc',
+ id: 'operations/monitoring/intro',
+ },
+ items: [
+ {
+ type: 'category',
+ label: 'InfluxDB',
+ link: {
+ type: 'doc',
+ id: 'operations/monitoring/influxdb/intro',
+ },
+ items: [
+ {
+ type: 'doc',
+ id: 'operations/monitoring/influxdb/influxdb'
+ },
+ {
+ type: 'doc',
+ id: 'operations/monitoring/influxdb/influxdb_maintenance'
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Configuration Guide',
+ items: [
+ {
+ type: 'doc',
+ id: 'configuration/intro'
+ },
+ ],
+ },
+ ],
+ DevelopmentSideBar: [
+ {
+ type: 'category',
+ label: 'Development Guide',
+ items: [
+ {
+ type: 'doc',
+ id: 'development/roadmap'
+ },
+ {
+ type: 'doc',
+ id: 'development/how_to_contribute'
+ },
+ {
+ type: 'doc',
+ id: 'development/how_to_develop'
+ },
+ {
+ type: 'doc',
+ id: 'development/how_to_package'
+ },
+ {
+ type: 'doc',
+ id: 'development/how_to_release'
+ },
+ ],
+ },
+ ],
+ CommunitySideBar: [
+ {
+ type: 'doc',
+ id: 'community',
+ label: 'Community',
+ },
+ ],
+ PowerBySideBar:[
+ {
+ type: 'doc',
+ id: 'powerBy',
+ label: 'PowerBy',
+ }
+ ],
};
module.exports = sidebars;