[incubator-kyuubi] branch master updated: [KYUUBI #3108][DOC] Fix path errors in the build document

[ya...@apache.org]

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

yao 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 4b640b720 [KYUUBI #3108][DOC] Fix path errors in the build document
4b640b720 is described below

commit 4b640b720254302017841f8405985117bc1b957c
Author: Luning Wang <wa...@gmail.com>
AuthorDate: Thu Jul 21 16:03:37 2022 +0800

    [KYUUBI #3108][DOC] Fix path errors in the build document
    
    ### _Why are the changes needed?_
    
    Fix path errors in the build document
    
    ### _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
    
    - [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request
    
    Closes #3109 from deadwind4/K3108.
    
    Closes #3108
    
    23830c6e [Luning Wang] [KYUUBI #3108][DOC] Fix path errors in the build document
    
    Authored-by: Luning Wang <wa...@gmail.com>
    Signed-off-by: Kent Yao <ya...@apache.org>
---
 docs/develop_tools/build_document.md | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/docs/develop_tools/build_document.md b/docs/develop_tools/build_document.md
index cd1706cd4..c3c310db3 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 $KYUUBI_HOME/docs
+cd $KYUUBI_SOURCE_PATH/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_HOME/bin/activate
+source ./kyuubi/bin/activate
 ```
 
 ## Install all dependencies
@@ -55,18 +55,20 @@ pip install -r requirements.txt
 ```
 
 ## Create Documentation
+
+Make sure you are in the `$KYUUBI_SOURCE_PATH/docs` directory.
+
 linux & macos
 ```bash
-cd $KYUUBI_HOME
 make html
 ```
 windows
 ```bash
-cd $KYUUBI_HOME
 make.bat html
 ```
-If the build process succeed, the HTML pages are in `$KYUUBI_HOME/_build/html`.
+
+If the build process succeed, the HTML pages are in `$KYUUBI_SOURCE_PATH/docs/_build/html`.
 
 ## View Locally
 
-Open the `$KYUUBI_HOME/_build/html/index.html` file in your favorite web browser.
+Open the `$KYUUBI_SOURCE_PATH/docs/_build/html/index.html` file in your favorite web browser.