jprdonnelly/impala
1
0
Fork 0
mirror of https://github.com/apache/impala.git synced 2025-12-19 18:12:08 -05:00
Code Issues Projects Releases Wiki Activity

IMPALA-12047: [DOCS] Fix a URL mistake when using "git clone" in docs/README.md

Browse Source 
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 <impala-public-jenkins@cloudera.com>
Reviewed-by: Daniel Becker <daniel.becker@cloudera.com>
Reviewed-by: Yingchun Lai <laiyingchun@apache.org>
This commit is contained in:
whsyourdaddy
2023-03-20 22:34:39 +08:00
committed by Daniel Becker
parent b8915c9a4d
commit bb237660a0
1 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/README.md
View File

@@ -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