Kent Yao e1921fc8c0

[KYUUBI #2751 ] [DOC] Replace sphinx_rtd_theme with sphinx_book_theme

### _Why are the changes needed?_

make documentation style to fit official web site

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [x] Add screenshots for manual tests if appropriate
![image](https://user-images.githubusercontent.com/8326978/170434595-d5ec5068-ab2d-484e-9371-9331311cc0f1.png)
- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #2751 from yaooqinn/doc2.

Closes #2751

b8123525 [Kent Yao] Switch

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>

2022-05-27 02:22:36 +08:00

2.6 KiB

Raw Blame History

Building Kyuubi

Building Kyuubi with Apache Maven

Kyuubi is built based on Apache Maven,

./build/mvn clean package -DskipTests

This results in the creation of all sub-modules of Kyuubi project without running any unit test.

If you want to test it manually, you can start Kyuubi directly from the Kyuubi project root by running

bin/kyuubi start

Building a Submodule Individually

For instance, you can build the Kyuubi Common module using:

build/mvn clean package -pl kyuubi-common -DskipTests

Building Submodules Individually

For instance, you can build the Kyuubi Common module using:

build/mvn clean package -pl kyuubi-common,kyuubi-ha -DskipTests

Skipping Some modules

For instance, you can build the Kyuubi modules without Kyuubi Codecov and Assembly modules using:

mvn clean install -pl '!dev/kyuubi-codecov,!kyuubi-assembly' -DskipTests

Building Kyuubi against Different Apache Spark versions

Since v1.1.0, Kyuubi support building with different Spark profiles,

Profile	Default	Since
-Pspark-3.0	Yes	1.0.0
-Pspark-3.1	No	1.1.0

Building with Apache dlcdn site

By default, we use https://archive.apache.org/dist/ to download the built-in release packages of engines, such as Spark or Flink. But sometimes, you may find it hard to reach, or the download speed is too slow, then you can define the apache.archive.dist by -Pmirror-cdn to accelerate to download speed. For example,

build/mvn clean package -Pmirror-cdn

The profile migrates your download repo to the Apache offically suggested site - https://dlcdn.apache.org. Note that, this site only holds the latest versions of Apache releases. You may fail if the specific version defined by spark.version or flink.version is overdue.

2.6 KiB Raw Blame History