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 8aa50a99c9 KYLIN-5221 Add how to package doc
8aa50a99c9 is described below
commit 8aa50a99c9e579aef40c95e89d27b0d6fea54892
Author: XiaoxiangYu <x...@apache.org>
AuthorDate: Fri Aug 12 18:14:01 2022 +0800
KYLIN-5221 Add how to package doc
---
README.md | 8 +++--
website/docs/development/how_to_package.md | 48 +++++++++++++++++++++++++++++-
2 files changed, 52 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 3518feaa70..d5201a55ff 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,9 @@ npm start
npm deploy
```
+### TODO List
-### How to push your change
-
-TODO
\ No newline at end of file
+- Search in document
+- SEO
+- Multi Version
+- i18n
\ 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 f8e8aaf0cf..a0ca3b1d3c 100644
--- a/website/docs/development/how_to_package.md
+++ b/website/docs/development/how_to_package.md
@@ -2,4 +2,50 @@
sidebar_position: 1
---
-# TODO
\ No newline at end of file
+# How to package
+
+### 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 |
+
+
+### 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 |
+
+### Package Content
+
+| Option | Comment |
+|-------------------- | ---------------|
+| VERSION | `Apache Kylin ${release_version}` |
+| commit_SHA1 | `${HASH_COMMIT}@${BRANCH_NAME}` |
+
+### Package Name convention
+
+Package name is `apache-kylin-${release_version}.tar.gz`, while
`${release_version}` is `{project.version}.YYYYmmDDHHMMSS` by default.
+For example, an unofficial package could be
`apache-kylin-5.0.0-SNAPSHOT.20220812161045.tar.gz` while an official package
could be `apache-kylin-5.0.0.tar.gz`
+
+### Example for developer and release manager
+
+```shell
+
+## Case 1: For developer who want to package for testing purpose
+cd 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
+```
\ No newline at end of file
