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/16 01:53:47 UTC
[kylin] 01/02: KYLIN-5221 Add how to switch older nodejs
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 e5247b5d2f7962c87d4eee647bb37462b16d1286
Author: XiaoxiangYu <xx...@apache.org>
AuthorDate: Mon Aug 15 11:31:14 2022 +0800
KYLIN-5221 Add how to switch older nodejs
---
website/README.md | 1 +
website/docs/development/how_to_contribute.md | 5 ++-
.../{how_to_develop.md => how_to_debug.md} | 2 +-
website/docs/development/how_to_package.md | 48 ++++++++++++++--------
website/docs/development/how_to_release.md | 2 +-
website/docs/development/how_to_test.md | 2 +-
website/docs/development/intro.md | 11 +----
website/docs/development/roadmap.md | 2 +-
website/docusaurus.config.js | 4 +-
website/sidebars.js | 2 +-
10 files changed, 43 insertions(+), 36 deletions(-)
diff --git a/website/README.md b/website/README.md
index e3e85e8b8f..670584e4b2 100644
--- a/website/README.md
+++ b/website/README.md
@@ -48,6 +48,7 @@ website
```shell
## Starts the development server.
+cd website
npm start
## Publishes the website to GitHub pages.
diff --git a/website/docs/development/how_to_contribute.md b/website/docs/development/how_to_contribute.md
index fc44a30698..3822834d97 100644
--- a/website/docs/development/how_to_contribute.md
+++ b/website/docs/development/how_to_contribute.md
@@ -2,4 +2,7 @@
sidebar_position: 1
---
-# TODO
+# How to contribute
+
+1. JIRA Issue
+2. Github
diff --git a/website/docs/development/how_to_develop.md b/website/docs/development/how_to_debug.md
similarity index 67%
rename from website/docs/development/how_to_develop.md
rename to website/docs/development/how_to_debug.md
index f8e8aaf0cf..926e10debb 100644
--- a/website/docs/development/how_to_develop.md
+++ b/website/docs/development/how_to_debug.md
@@ -2,4 +2,4 @@
sidebar_position: 1
---
-# TODO
\ No newline at end of file
+# How to debug
\ No newline at end of file
diff --git a/website/docs/development/how_to_package.md b/website/docs/development/how_to_package.md
index a0ca3b1d3c..72d0708f45 100644
--- a/website/docs/development/how_to_package.md
+++ b/website/docs/development/how_to_package.md
@@ -6,30 +6,30 @@ sidebar_position: 1
### Environment Requirement
-| Software | Comment |
-|---------------| ---------------------|
-| Git | Fetch branch name and hash of latest commit |
-| Apache Maven | Build Java and Scala source code |
-| Node.js | Build front end |
+| Software | Comment | Version |
+|---------------| ---------------------------------------------|----------------|
+| Git | Fetch branch name and hash of latest commit | latest |
+| Apache Maven | Build Java and Scala source code | 3.8.2 or latest |
+| Node.js | Build front end | 12.14.0 is recommended ( or 12.x ~ 14.x) |
### Options for Packaging Script
-| Option | Comment |
-|-------------------- | ---------------|
-| -official | Should package name contains timestamp, default no |
-| -noThirdParty | Should third party binary be packaging into binary, current they are influxdb,grafana and postgresql, default no |
-| -noSpark | Should spark be packaging into Kylin binary, default yes |
-| -noHive1 | Should this binary support Hive 1.2, by default kylin will support Hive 2.3+ |
-| -skipFront | Should build front end, default yes |
-| -skipCompile | Should build back end, default yes |
+| Option | Comment |
+|-------------------- | ---------------------------------------------------|
+| -official | If add this option, package name contains timestamp|
+| -noThirdParty | If add this option, third party binary be packaging into binary, current they are influxdb,grafana and postgresql |
+| -noSpark | If add this option, spark won't packaging into Kylin binary |
+| -noHive1 | By default kylin 5.0 will support Hive 1.2, if add this option, this binary will support Hive 2.3+ |
+| -skipFront | If add this option, front-end won't be build and packaging |
+| -skipCompile | Add this option will assume java source code no need be compiled again |
### Package Content
| Option | Comment |
|-------------------- | ---------------|
| VERSION | `Apache Kylin ${release_version}` |
-| commit_SHA1 | `${HASH_COMMIT}@${BRANCH_NAME}` |
+| commit_SHA1 | `${HASH_COMMIT}@${BRANCH_NAME}` |
### Package Name convention
@@ -41,11 +41,23 @@ For example, an unofficial package could be `apache-kylin-5.0.0-SNAPSHOT.2022081
```shell
## Case 1: For developer who want to package for testing purpose
-cd build/release
-./release.sh
+./build/release/release.sh
## Case 2: Official apache release, kylin binary for deploy on Hadoop3+ and Hive2.3+,
# and third party cannot be distributed because of apache distribution policy(size and license)
-cd build/release
-./release.sh -noThirdParty -noSpark -official
+./build/release/release.sh -noSpark -official
+```
+
+### How to switch to older node.js
+
+If you install node.js which is higher than 14.X, I recommended you downgrade to lower version with some tools like https://github.com/nvm-sh/nvm.
+
+```shell
+## switch to specific version
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
+nvm install 12.14.0
+nvm use 12.14.0
+
+## switch to original version
+nvm use system
```
\ No newline at end of file
diff --git a/website/docs/development/how_to_release.md b/website/docs/development/how_to_release.md
index f8e8aaf0cf..ddb0438605 100644
--- a/website/docs/development/how_to_release.md
+++ b/website/docs/development/how_to_release.md
@@ -2,4 +2,4 @@
sidebar_position: 1
---
-# TODO
\ No newline at end of file
+# How to release
\ No newline at end of file
diff --git a/website/docs/development/how_to_test.md b/website/docs/development/how_to_test.md
index f8e8aaf0cf..4d07fd24e9 100644
--- a/website/docs/development/how_to_test.md
+++ b/website/docs/development/how_to_test.md
@@ -2,4 +2,4 @@
sidebar_position: 1
---
-# TODO
\ No newline at end of file
+# How to test
\ No newline at end of file
diff --git a/website/docs/development/intro.md b/website/docs/development/intro.md
index 3d61612265..d4597f0c27 100644
--- a/website/docs/development/intro.md
+++ b/website/docs/development/intro.md
@@ -13,13 +13,4 @@ draft: false
last_update:
date: 12/08/2022
---
-# Tutorial Intro
-
-Let's discover ** Kylin 5.0 in than 15 minutes **.
-
-## Getting Started
-
-```shell
-
-docker pull apachekylin/apache-kylin-standalone:5.0.0
-```
+# Guide of developer
diff --git a/website/docs/development/roadmap.md b/website/docs/development/roadmap.md
index fc44a30698..fff02a3a92 100644
--- a/website/docs/development/roadmap.md
+++ b/website/docs/development/roadmap.md
@@ -2,4 +2,4 @@
sidebar_position: 1
---
-# TODO
+# Roadmap
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
index 0487fbce13..a396bd12b8 100644
--- a/website/docusaurus.config.js
+++ b/website/docusaurus.config.js
@@ -38,14 +38,14 @@ const config = {
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
- 'https://github.com/apache/kylin/tree/kylin5/document/website/',
+ 'https://github.com/apache/kylin/tree/doc5.0/website/',
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
- 'https://github.com/apache/kylin/tree/kylin5/document/website/',
+ 'https://github.com/apache/kylin/tree/doc5.0/website/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
diff --git a/website/sidebars.js b/website/sidebars.js
index c971863094..cccca0d88f 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -332,7 +332,7 @@ const sidebars = {
},
{
type: 'doc',
- id: 'development/how_to_develop'
+ id: 'development/how_to_debug'
},
{
type: 'doc',