This is an automated email from the ASF dual-hosted git repository. michaelsmith pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/impala.git
commit bb237660a0cca7a2315ac419058cd8b7cc84073c Author: whsyourdaddy <[email protected]> AuthorDate: Mon Mar 20 22:34:39 2023 +0800 IMPALA-12047: [DOCS] Fix a URL mistake when using "git clone" in docs/README.md There's a URL mistake when using "git clone" in docs/README.md: git clone https://gitbox.apache.org/repos/asf/impala.git/docs This doesn't work and it will prompt "repository not found". This change corrects the description, providing two ways to download the docs - either by downloading the whole repository and going to the docs/ directory or by downloading only the docs using git sparse-checkout. Change-Id: Ib00c37e28e67cca5b3630742b4c366dea4e967b7 Reviewed-on: http://gerrit.cloudera.org:8080/19634 Tested-by: Impala Public Jenkins <[email protected]> Reviewed-by: Daniel Becker <[email protected]> Reviewed-by: Yingchun Lai <[email protected]> --- docs/README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index 02d1f5dc2..4365dd330 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,16 +9,29 @@ instructions. ## Download Docs Source -* Open a terminal window and run the following commands to get the Impala - documentation source files from Git: +* There are two ways to obtain docs sources. + * Clone the whole repository. Open a terminal window and run the following + commands to get the whole Impala repository from Git and go to the docs folder: ``` - git clone https://gitbox.apache.org/repos/asf/impala.git/docs - cd <local_directory> - git checkout master + git clone https://gitbox.apache.org/repos/asf/impala.git + cd <local_directory> + git checkout master + cd docs/ ``` Where `master` is the branch where Impala documentation source files are uploaded. + * Clone only the docs directory. Open a terminal window and run the following + commands to get only the Impala documentation source files from Git: + ``` + git init impala_docs + cd impala_docs + git remote add origin https://gitbox.apache.org/repos/asf/impala.git + git sparse-checkout set docs/ + git pull origin master + cd docs/ + ``` + You'll see only the 'docs/' sub-directory is downloaded. ## Download DITA Open Toolkit
