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/10/25 06:40:19 UTC

[kylin] branch doc5.0 updated: Improve doc about Windows dev env setup

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 2ba907a70d Improve doc about Windows dev env setup
2ba907a70d is described below

commit 2ba907a70dc75ceedeae52b52f5d11c11e0dc00e
Author: Li Yang <li...@apache.org>
AuthorDate: Sat Oct 22 20:13:58 2022 +0800

    Improve doc about Windows dev env setup
---
 website/docs/development/how_to_contribute.md           | 5 +++++
 website/docs/development/how_to_debug_kylin_in_ide.md   | 4 ++++
 website/docs/development/how_to_debug_kylin_in_local.md | 4 ++++
 3 files changed, 13 insertions(+)

diff --git a/website/docs/development/how_to_contribute.md b/website/docs/development/how_to_contribute.md
index 468223aad6..47598c117d 100644
--- a/website/docs/development/how_to_contribute.md
+++ b/website/docs/development/how_to_contribute.md
@@ -59,6 +59,11 @@ The overview is followed by step-by-step instructions.
 6. Make related document changes following [how to write document](./how_to_write_doc).
 
 ### Step 1. Setup a development environment
+
+:::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 in WSL for best performance.
+:::
+
 1. Visit the https://github.com/apache/kylin and click the **Fork** button.
    ![](images/fork_github_repo.png)
 2. Clone the fork repo to local
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 74944ac7eb..d13a0efb85 100644
--- a/website/docs/development/how_to_debug_kylin_in_ide.md
+++ b/website/docs/development/how_to_debug_kylin_in_ide.md
@@ -31,6 +31,10 @@ This guide **assumes** you have prepared the following things:
 - [ ] 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
 
+:::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.
+:::
+
 ### Prepare IDEA and build source code
 
 #### Step 1: Check Software Requirement
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 2ce2595310..dcbfc7b823 100644
--- a/website/docs/development/how_to_debug_kylin_in_local.md
+++ b/website/docs/development/how_to_debug_kylin_in_local.md
@@ -32,6 +32,10 @@ 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
 
+:::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.
+:::
+
 ### Prepare IDEA and build source code
 
 #### Step 1: Check Software Requirement