[incubator-kyuubi] branch master updated: [KYUUBI #3005] [DOCS] Correct spelling errors and optimizations in 'Building Kyuubi Documentation' part

[ch...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

chengpan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-kyuubi.git


The following commit(s) were added to refs/heads/master by this push:
     new 3203829f7 [KYUUBI #3005] [DOCS] Correct spelling errors and optimizations in 'Building Kyuubi Documentation' part
3203829f7 is described below

commit 3203829f7d399ee74f66a3d49f80d97744e291c2
Author: lxorc <13...@163.com>
AuthorDate: Tue Jul 5 10:44:10 2022 +0800

    [KYUUBI #3005] [DOCS] Correct spelling errors and optimizations in 'Building Kyuubi Documentation' part
    
    ### _Why are the changes needed?_
    Correct spelling and smooth documentation make the community better.
    
    ### _How was this patch tested?_
    - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
    
    - [ ] Add screenshots for manual tests if appropriate
    
    - [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request
    
    Closes #3006 from lxorc/master.
    
    Closes #3005
    
    ca294af5 [lxorc] [DOCS] Correct spelling errors and optimizations in 'Building Kyuubi Documentation'
    
    Authored-by: lxorc <13...@163.com>
    Signed-off-by: Cheng Pan <ch...@apache.org>
---
 docs/develop_tools/build_document.md | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

diff --git a/docs/develop_tools/build_document.md b/docs/develop_tools/build_document.md
index 163f61654..cd1706cd4 100644
--- a/docs/develop_tools/build_document.md
+++ b/docs/develop_tools/build_document.md
@@ -31,7 +31,7 @@ pip install virtualenv
 Switch to the `docs` root directory.
 
 ```bash
-cd $KTUUBI_HOME/docs
+cd $KYUUBI_HOME/docs
 ```
 
 Create a virtual environment named 'kyuubi' or anything you like using `virtualenv` if it's not existing.
@@ -43,7 +43,7 @@ virtualenv kyuubi
 Activate it,
 
 ```bash
-source ./kyuubi/bin/activate
+source $KYUUBI_HOME/bin/activate
 ```
 
 ## Install all dependencies
@@ -55,13 +55,18 @@ pip install -r requirements.txt
 ```
 
 ## Create Documentation
-
+linux & macos
 ```bash
+cd $KYUUBI_HOME
 make html
 ```
-
-If the build process succeed, the HTML pages are in `_build/html`.
+windows
+```bash
+cd $KYUUBI_HOME
+make.bat html
+```
+If the build process succeed, the HTML pages are in `$KYUUBI_HOME/_build/html`.
 
 ## View Locally
 
-Open the `_build/html/index.html` file in your favorite web browser.
+Open the `$KYUUBI_HOME/_build/html/index.html` file in your favorite web browser.