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/12/23 06:19:02 UTC
[kylin] 02/03: fix some spelling mistakes of kylin doc
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 ef9338c27808c4b8fd0af7cda8995780bccd90d3
Author: pengfei.zhan <de...@gmail.com>
AuthorDate: Sun Dec 18 20:04:27 2022 +0800
fix some spelling mistakes of kylin doc
---
website/docs/development/coding_convention.md | 16 ++++-----
.../docs/development/how_to_debug_kylin_in_ide.md | 30 ++++++++---------
.../development/how_to_debug_kylin_in_local.md | 24 +++++++-------
website/docs/development/how_to_package.md | 38 +++++++++++-----------
.../development/how_to_subscribe_mailing_list.md | 14 ++++----
.../development/how_to_understand_kylin_design.md | 6 ++--
website/docs/development/intro.md | 6 ++--
website/docs/development/roadmap.md | 12 +++----
8 files changed, 73 insertions(+), 73 deletions(-)
diff --git a/website/docs/development/coding_convention.md b/website/docs/development/coding_convention.md
index 68c64710d1..2be9bea478 100644
--- a/website/docs/development/coding_convention.md
+++ b/website/docs/development/coding_convention.md
@@ -16,15 +16,15 @@ last_update:
author: Tengting Xu
---
-Coding convention is very important for teamwork. Not only it keeps code neat and tidy, it saves a lot of work too. Different coding convention (and auto formatter) will cause unnecessary code changes that requires more effort at code review and code merge.
+Coding convention is very important for teamwork. Not only it keeps code neat and tidy, but it also saves a lot of work too. Different coding convention (and auto formatter) will cause unnecessary code changes that require more effort at code review and code merge.
## Setup IDE code formatter
-For Java code, we use Eclipse default formatter setting, with one change that to allow long lines.
+For Java code, we use Eclipse's default formatter setting, with one change that allows long lines.
-- For Eclipse developers, no manual setting is required. Code formatter configurations `src/core-common/.settings/org.eclipse.jdt.core.prefs` is on git repo. Your IDE should be auto configured when the projects are imported.
+- For Eclipse developers, no manual setting is required. Code formatter configurations `src/core-common/.settings/org.eclipse.jdt.core.prefs` are on the git repo. Your IDE should be auto-configured when the projects are imported.
-- For intellij IDEA developers, you need to install `Eclipse Code Formatter` and load the Eclipse formatter settings into your IDE manually.
+- For IntelliJ IDEA developers, you need to install `Eclipse Code Formatter` and load the Eclipse formatter settings into your IDE manually.
you have to do a few more steps:
@@ -36,7 +36,7 @@ For Java code, we use Eclipse default formatter setting, with one change that to
- 3. Disable intellij IDEA’s `Optimize imports on the fly`
+ 3. Disable IntelliJ IDEA’s `Optimize imports on the fly`
@@ -64,7 +64,7 @@ See the License for the specific language governing permissions and
limitations under the License.
```
-The checkstyle plugin will check the header rule when packaging also. The license file locates under `dev-support/checkstyle-apache-header.txt`. To make it easy for developers, please add the header as Copyright Profile and set it as default for Kylin project.
+The checkstyle plugin will check the header rule when packaging also. The license file locates under `dev-support/checkstyle-apache-header.txt`. To make it easy for developers, please add the header as Copyright Profile and set it as default for the Kylin project.
@@ -80,8 +80,8 @@ The checkstyle plugin will check the header rule when packaging also. The licens
5. Add a new test or modified a test.
- 1) Please using the `junit5` instead of `junit4`. Example, Using the annotation of `org.junit.jupiter.api.Test` instead of `org.junit.Test`.
+ 1) Please use the `junit5` instead of `junit4`. For example, Using the annotation of `org.junit.jupiter.api.Test` instead of `org.junit.Test`.
- 2) A test case which extends from `NLocalFileMetadataTestCase` need to change with annotation `@MetadataInfo` and remove the `extend`.
+ 2) A test case that extends from `NLocalFileMetadataTestCase` needs to change with annotation `@MetadataInfo` and remove the `extend`.
> Example: org.apache.kylin.junit.MetadataExtension, org.apache.kylin.metadata.epoch.EpochManagerTest
diff --git a/website/docs/development/how_to_debug_kylin_in_ide.md b/website/docs/development/how_to_debug_kylin_in_ide.md
index d13a0efb85..2849292178 100644
--- a/website/docs/development/how_to_debug_kylin_in_ide.md
+++ b/website/docs/development/how_to_debug_kylin_in_ide.md
@@ -18,55 +18,55 @@ last_update:
### Background
#### Why debug Kylin in IDEA using docker
-This article aims to introduce a simple and useful way to develop and debug Kylin for developer, and provided similar deployment to user's real scenario.
+This article aims to introduce a simple and useful way to develop and debug Kylin for developers and provided a similar deployment to the user's real scenario.
#### Deployment architecture
-Following is architecture of current deployment.
+Following is the architecture of the current deployment.
This guide **assumes** you have prepared the following things:
-- [ ] A **laptop** with MacOS installed to do development work (Windows is not verified at the moment)
-- [ ] A **remote linux server** for testing and deployment purpose(if you do not prepare remote linux server, you will deploy Hadoop on your laptop)
-- [ ] kylin's source code is cloned into some directory in your laptop
+- [ ] A **laptop** with macOS installed to do development work (Windows is not verified at the moment)
+- [ ] A **remote Linux server** for testing and deployment purposes (if you do not prepare a remote Linux server, you will deploy Hadoop on your laptop)
+- [ ] Kaylin's source code is cloned into some directory on your laptop
:::info For Windows Dev Machine
-For Windows dev machine, setup the Kylin dev env in [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/about) is the best option. Follow this guide on [how to install WSL with GUI](https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps), and install both Kylin code and your favorite IDE (but not the docker) in WSL for best performance.
+For Windows dev machine, setup the Kylin dev env in [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/about) is the best option. Follow this guide on [how to install WSL with GUI](https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps), and install both the Kylin code and your favorite IDE (but not the docker) in WSL for best performance.
:::
### Prepare IDEA and build source code
#### Step 1: Check Software Requirement
-Please visit [software_requirement](how_to_package#software_reqiurement), make sure your laptop has meet the requirement.
+Please visit [software_requirement](how_to_package#software_reqiurement), and make sure your laptop has met the requirement.
#### Step 2: Build source code
-- Build back-end source code before your start debug.
+- Build backend source code before your start debugging.
```shell
cd <path-to-kylin-source>
mvn clean install -DskipTests
```
- Build front-end source code.
-(Please use node.js **v12.14.0**, for how to use specific version of node.js, please check [how to switch to specific node js](how_to_package#install_older_node) )
+(Please use node.js **v12.14.0**, for how to use a specific version of node.js, please check [how to switch to a specific node js](how_to_package#install_older_node) )
```shell
cd kystudio
npm install
```
#### Step 3: Install IntelliJ IDEA and build the source
-1. Install IDEA Community edition (Ultimate edition is ok too).
-2. Import the source code into IDEA. Click the **Open**, and choose the directory of **kylin source code**.
- 
+1. Install the IDEA Community edition (the Ultimate edition is ok too).
+2. Import the source code into IDEA. Click the **Open**, and choose the directory of **Kylin source code**.
+ 
-3. Install scala plugin and restart
+3. Install the scala plugin and restart
-4. Configure SDK(JDK and Scala), make sure you use **JDK 1.8.X** and **Scala 2.12.X**.
+4. Configure SDK(JDK and Scala), and make sure you use **JDK 1.8.X** and **Scala 2.12.X**.
-5. Reload maven projects, and directory `scala` will be marked as source root(in blue color).
+5. Reload maven projects, and the `scala` directory will be marked as source root(in blue color).
6. Build the projects.(make sure you have executed `mvn clean package -DskipTests`, otherwise some source code is not generated by maven javacc plugin)
diff --git a/website/docs/development/how_to_debug_kylin_in_local.md b/website/docs/development/how_to_debug_kylin_in_local.md
index dcbfc7b823..57a1d694e9 100644
--- a/website/docs/development/how_to_debug_kylin_in_local.md
+++ b/website/docs/development/how_to_debug_kylin_in_local.md
@@ -19,32 +19,32 @@ last_update:
### Background
#### Why debug Kylin in IDEA without Hadoop
-This article aims to introduce a simple and useful way to develop and debug Kylin for developer.
+This article aims to introduce a simple and useful way to develop and debug Kylin for developers.
#### Deployment architecture
-Following is architecture of current deployment.
+Following is the architecture of the current deployment.
This guide **assumes** you have prepared the following things:
-- [X] A **laptop** with MacOS installed to do development work (Windows is not verified at the moment)
-- [X] kylin's source code is cloned into some directory in your laptop
+- [X] A **laptop** with macOS installed to do development work (Windows is not verified at the moment)
+- [X] Kylin's source code is cloned into some directory on your laptop
:::info For Windows Dev Machine
-For Windows dev machine, setup the Kylin dev env in [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/about) is the best option. Follow this guide on [how to install WSL with GUI](https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps), and install both Kylin code and your favorite IDE (but not the docker) in WSL for best performance.
+For Windows dev machine, setup the Kylin dev env in [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/about) is the best option. Follow this guide on [how to install WSL with GUI](https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps), and install both the Kylin code and your favorite IDE (but not the docker) in WSL for best performance.
:::
### Prepare IDEA and build source code
#### Step 1: Check Software Requirement
-Please visit [Software Requirement](how_to_package#software_reqiurement), make sure your laptop has meet the requirement.
+Please visit [Software Requirement](how_to_package#software_reqiurement), and make sure your laptop has met the requirement.
#### Step 2: Build source code
-- Build back-end source code before your start debug.
+- Build backend source code before your start debugging.
```shell
cd <path-to-kylin-source>
@@ -53,7 +53,7 @@ Please visit [Software Requirement](how_to_package#software_reqiurement), make s
- Build front-end source code.
- (Please use node.js **v12.14.0**, for how to use specific version of node.js, please check [how to switch to specific node js](how_to_package#install_older_node) )
+ (Please use node.js **v12.14.0**, for how to use a specific version of node.js, please check [how to switch to a specific node js](how_to_package#install_older_node) )
```shell
cd kystudio
@@ -61,18 +61,18 @@ Please visit [Software Requirement](how_to_package#software_reqiurement), make s
```
#### Step 3: Install IntelliJ IDEA and build the source
-1. Install IDEA Community edition (Ultimate edition is ok too).
+1. Install the IDEA Community edition (the Ultimate edition is ok too).
-2. Import the source code into IDEA. Click the **Open**, and choose the directory of **kylin source code**.
+2. Import the source code into IDEA. Click the **Open**, and choose the directory of **Kylin source code**.
-3. Install scala plugin and restart
+3. Install the scala plugin and restart
4. Configure SDK(JDK and Scala), make sure you use **JDK 1.8.X** and **Scala 2.12.X**.
-5. Reload maven projects, and directory `scala` will be marked as source root(in blue color).
+5. Reload maven projects, and the `scala` directory will be marked as source root(in blue color).
6. Build the projects.(make sure you have executed `mvn clean package -DskipTests`, otherwise some source code is not generated by maven javacc plugin)
diff --git a/website/docs/development/how_to_package.md b/website/docs/development/how_to_package.md
index b8d29eb65e..8fdbc34373 100644
--- a/website/docs/development/how_to_package.md
+++ b/website/docs/development/how_to_package.md
@@ -22,11 +22,11 @@ last_update:
| Software | Comment | Version | Download Link |
|---------------| ---------------------------------------------|----------------|--------------------|
| Git | Fetch branch name and hash of latest commit | latest | https://git-scm.com/book/en/v2/Getting-Started-Installing-Git |
-| Apache Maven | Build Java and Scala source code | 3.8.2 or latest| https://maven.apache.org/download.cgi |
+| Apache Maven | Build Java and Scala source code | 3.8.2 or latest| https://maven.apache.org/download.cgi |
| Node.js | Build front end | 12.14.0 is recommended ( or 12.x ~ 14.x) | [How to switch to older node.js](development/how_to_package.md#install_older_node)|
| JDK | Java Compiler and Development Tools | JDK 1.8.x | https://www.oracle.com/java/technologies/javase/javase8u211-later-archive-downloads.html |
-After installed above software, please do verify **software requirement** by following commands:
+After installing the above software, please verify **software requirements** by following commands:
```shell
$ java -version
@@ -49,14 +49,14 @@ git version 2.30.1 (Apple Git-130)
```
### Options for Packaging Script
-| Option | Comment |
-|-------------------- | ---------------------------------------------------|
-| -official | If add this option, package name won't contain timestamp|
-| -noThirdParty | If add this option, third party binary won't 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 |
+| Option | Comment |
+| ------------- | ------------------------------------------------------------ |
+| -official | If adding this option, the package name won't contain the timestamp |
+| -noThirdParty | If adding this option, third-party binary won't be packaged into binary, current they are influxdb,grafana and PostgreSQL |
+| -noSpark | If adding this option, spark won't be packaged into the 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, the front-end won't be built and packaged |
+| -skipCompile | Add this option will assume java source code no need to be compiled again |
### Other Options for Packaging Script
| Option | Comment |
@@ -79,11 +79,11 @@ 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
+## Case 1: For the developer who wants to package for testing purposes
./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)
+## Case 2: Official apache release, Kylin binary for deployment on Hadoop3+ and Hive2.3+,
+# and the third party cannot be distributed because of apache distribution policy(size and license)
./build/release/release.sh -noSpark -official
## Case 3: A package for Apache Hadoop 3 platform
@@ -92,31 +92,31 @@ For example, an unofficial package could be `apache-kylin-5.0.0-SNAPSHOT.2022081
### <span id="install_older_node">How to install older node.js</span>
-1. Please visit https://nodejs.org/en/download/ to download and install the latest node.js . After installed, you may use follow command to verify if the latest node.js is in use:
+1. Please visit https://nodejs.org/en/download/ to download and install the latest node.js. After installed, you may use the following command to verify if the latest node.js is in use:
```shell
$ node -v
v16.17.0
```
-2. Use some tools like https://github.com/nvm-sh/nvm to install specific version of node.js
+2. Use some tools like https://github.com/nvm-sh/nvm to install a specific version of node.js
```shell
## Switch to specific version using nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
nvm install 12.14.0
-## Before packaging, please switch to specific version
+## Before packaging, please switch to a specific version
nvm use 12.14.0
```
-You may use follow command to verify if older node.js is in use:
+You may use the following command to verify if older node.js is in use:
```shell
$ node -v
v12.14.0
```
-3. Switch to latest node.js
+3. Switch to the latest node.js
```shell
-## switch to original version
+## switch to the original version
nvm use system
```
diff --git a/website/docs/development/how_to_subscribe_mailing_list.md b/website/docs/development/how_to_subscribe_mailing_list.md
index 6e37297afa..b8c8b8d79e 100644
--- a/website/docs/development/how_to_subscribe_mailing_list.md
+++ b/website/docs/development/how_to_subscribe_mailing_list.md
@@ -14,7 +14,7 @@ last_update:
---
### Mailing List Table
-These are the mailing lists that have been established for kylin project. For each list, there is a subscribe, unsubscribe, and an archive link.
+These are the mailing lists that have been established for the Kylin project. For each list, there is a subscribe, unsubscribe, and archive link.
| Mailing List | Subscribe Link | Unsubscribe Link | Archive Link |
|:------------:|:----------------------------------------------------:|:--------------------------------------------------------:|:-------------------------------------------------------------------------:|
@@ -25,23 +25,23 @@ These are the mailing lists that have been established for kylin project. For ea
### <span id="mailing_list">Subscribe mailing list</span>
-#### Step 1: Send subscribe request
-You click the _Subscribe Link_ in above table, and send the simple request(it is ok to leave the title and body with a very short sentence) to the appropriate address .
+#### Step 1: Send subscription request
+You click the _Subscribe Link_ in the above table and send the simple request(it is ok to leave the title and body with a very short sentence) to the appropriate address.
#### Step 2: Receive confirmation reply from ezmlm
-The mailing list management program, [ezmlm](http://untroubled.org/ezmlm/), will send you a reply in 2-10 minutes, ask you to **confirm your subscription**.
+The mailing list management program, [ezmlm](http://untroubled.org/ezmlm/), will send you a reply in 2-10 minutes, asking you to **confirm your subscription**.
Following is a successful case.
-#### Step 3: Send confirmation request by replying to previous email
+#### Step 3: Send a confirmation request by replying to the previous email
Reply to the previous email(it is ok to leave the title and body with a short sentence)
-#### Step 4: ezmlm acknowledge your confirmation request
-You will receive "Welcome to user/dev@kylin.apache.org" in 2-10 minutes. From now, you have right to send and receive mails from all subscribers of current mailing list.
+#### Step 4: ezmlm acknowledges your confirmation request
+You will receive "Welcome to user/dev@kylin.apache.org" in 2-10 minutes. From now, you have the right to send and receive mail from all subscribers of the current mailing list.
Following is a successful case.
diff --git a/website/docs/development/how_to_understand_kylin_design.md b/website/docs/development/how_to_understand_kylin_design.md
index 735c550ee5..e660d1ac8d 100644
--- a/website/docs/development/how_to_understand_kylin_design.md
+++ b/website/docs/development/how_to_understand_kylin_design.md
@@ -21,14 +21,14 @@ last_update:
Unless more comments, all source code analysis are based on [this code snapshot](https://github.com/apache/kylin/tree/edab8698b6a9770ddc4cd00d9788d718d032b5e8) .
:::
-### About Design of Kylin 5.0
+### About the Design of Kylin 5.0
1. Metadata Store
- [x] Metadata Store
- [ ] Metadata Cache
- [x] Transaction(CRUD of Metadata)
- - [ ] Epoch, AuditLog etc.
+ - [ ] Epoch, AuditLog, etc.
2. Metadata Format/Schema
- - [ ] DataModel, IndexPlan and Dataflow
+ - [ ] DataModel, IndexPlan, and Dataflow
- [ ] Index and Layout
- [ ] Computed Column
3. Query Engine
diff --git a/website/docs/development/intro.md b/website/docs/development/intro.md
index c33cd133d4..94e34d4109 100644
--- a/website/docs/development/intro.md
+++ b/website/docs/development/intro.md
@@ -19,7 +19,7 @@ last_update:
Check out the [How to Contribute](how_to_contribute.md) document.
### Source Repository
-Apache Kylin™ source code is version controlled using Git version control:
+Apache Kylin™ source code is version-controlled using Git version control:
| Repository | Link |
|:------------------|:------------------------------------------------|
@@ -32,8 +32,8 @@ Apache Kylin™ source code is version controlled using Git version control:
Track issues on the **Kylin Project** on the [Apache JIRA](http://issues.apache.org/jira/browse/KYLIN)
### Wiki
-Please check [How to contribute wiki](https://cwiki.apache.org/confluence/display/KYLIN/How+to+contribute+wiki) .
+Please check [How to contribute wiki](https://cwiki.apache.org/confluence/display/KYLIN/How+to+contribute+wiki).
### Roadmap
-Please check [Roadmap of Kylin 5.0](./roadmap.md)
\ No newline at end of file
+Please check the [Roadmap of Kylin 5.0](./roadmap.md)
\ No newline at end of file
diff --git a/website/docs/development/roadmap.md b/website/docs/development/roadmap.md
index 027ac80936..33fd279077 100644
--- a/website/docs/development/roadmap.md
+++ b/website/docs/development/roadmap.md
@@ -20,8 +20,8 @@ last_update:
### Kylin 5.0.0
- More flexible and enhanced data model
- - Allow adding new dimensions and measures to exiting data model
- - Model adapts to table schema changes while retaining existing index at best effort
+ - Allow adding new dimensions and measures to the existing data model
+ - The model adapts to table schema changes while retaining the existing index at the best effort
- Support last-mile data transformation using Computed Column
- Support raw query (non-aggregation query) using Table Index
- Support changing dimension table (SCD2)
@@ -32,9 +32,9 @@ last_update:
- More flexible index management (was cuboid)
- Add IndexPlan to support flexible index management
- Add IndexEntity to support different index type
- - Add LayoutEntity to support different storage layout of same Index
-- Towards a native and vectorized query engine
- - Experiment: Integrate with native execution engine, leveraging Gluten
+ - Add LayoutEntity to support different storage layouts of the same Index
+- Toward a native and vectorized query engine
+ - Experiment: Integrate with a native execution engine, leveraging Gluten
- Support async query
- Enhance cost-based index optimizer
- More
@@ -44,4 +44,4 @@ last_update:
### Kylin 5.1.0
-- Support deploy Kylin on K8S with micro-service architecture
+- Support deploying Kylin on K8S with micro-service architecture