This is an automated email from the ASF dual-hosted git repository.
jinsongzhou pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/amoro.git
The following commit(s) were added to refs/heads/master by this push:
new 7b1414258 [Hotfix][Docs] Fix README.md adapt to new module name (#2781)
7b1414258 is described below
commit 7b14142586377efc624882b25e1e7885a8484f08
Author: Qishang Zhong <[email protected]>
AuthorDate: Wed Apr 24 19:40:11 2024 +0800
[Hotfix][Docs] Fix README.md adapt to new module name (#2781)
* [Hotfix][Docs] Fix README.md adapt to new module name
* Remove typo character
* [Hotfix][Docs] Fix README.md adapt to new module name
---
CONTRIBUTING.md | 9 +++++----
README.md | 30 +++++++++++++++---------------
2 files changed, 20 insertions(+), 19 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c4febda72..9eb56d4c6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -79,7 +79,8 @@ a [design document
template](https://docs.google.com/document/d/1LeTyrlzQJfSs2Dk
for reference.
## Building the Project Locally
-Amoro is built using Maven with Java 1.8 and Java 17(only for
`mixed-format/trino` module).
+
+Amoro is built using Maven with Java 1.8 and Java 17(only for
`amoro-mixed-format/amoro-mixed-format-trino` module).
* To build Trino module need config `toolchains.xml` in `${user.home}/.m2/`
dir, the content is
@@ -101,15 +102,15 @@ Amoro is built using Maven with Java 1.8 and Java 17(only
for `mixed-format/trin
* To invoke a build and run tests: `mvn package -P toolchain`
* To skip tests: `mvn -DskipTests package -P toolchain`
-* To package without trino module and JAVA 17 dependency: `mvn clean package
-DskipTests -pl '!mixed-format/trino'`
+* To package without trino module and JAVA 17 dependency: `mvn clean package
-DskipTests -pl '!amoro-mixed-format/amoro-mixed-format-trino'`
* To build with hadoop 2.x(the default is 3.x) `mvn clean package -DskipTests
-Dhadoop=v2`
* To indicate Flink version for optimizer (the default is 1.18.1): `mvn clean
package -Dflink-optimizer.flink-version=1.15.4`. If the version of Flink is
below 1.15.0, you also need to add the `-Pflink-pre-1.15` parameter: `mvn clean
package -Pflink-pre-1.15 -Dflink-optimizer.flink-version=1.14.6`.
`mvn clean package -Pflink-pre-1.15 -Dflink-optimizer.flink-version=1.14.6
-DskipTests`
>Spotless is skipped by default in `trino` module. So if you want to perform
>checkstyle when building `trino` module, you must be in a Java 17 environment.
-* To invoke a build include `mixed-format/trino` module in Java 17
environment: `mvn clean package -DskipTests -P trino-spotless`
-* To only build `mixe-format/trino` and its dependent modules in Java 17
environment: `mvn clean package -DskipTests -P trino-spotless -pl
'mixed-format/trino' -am`
+* To invoke a build include `amoro-mixed-format/amoro-mixed-format-trino`
module in Java 17 environment: `mvn clean package -DskipTests -P trino-spotless`
+* To only build `amoro-mixed-format/amoro-mixed-format-trino` and its
dependent modules in Java 17 environment: `mvn clean package -DskipTests -P
trino-spotless -pl 'amoro-mixed-format/amoro-mixed-format-trino' -am`
## Code suggestions
diff --git a/README.md b/README.md
index 42e8f6d76..adc83c388 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
<!--
-r
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
@@ -35,7 +34,7 @@ r
</a>
</p>
-Amoro(former name was Arctic) is a Lakehouse management system built on open
data lake formats.
+Apache Amoro (incubating) is a Lakehouse management system built on open data
lake formats.
Working with compute engines including Flink, Spark, and Trino, Amoro brings
pluggable and self-managed features for Lakehouse to provide out-of-the-box
data warehouse experience,
and helps data platforms or products easily build infra-decoupled,
stream-and-batch-fused and lake-native architecture.
@@ -98,20 +97,20 @@ Amoro contains modules as below:
- `amoro-core` contains core abstractions and common implementation for other
modules
- `amoro-ams` is amoro management service module
- - `ams-api` contains ams thrift api and common interfaces
- - `ams-dashboard` is the dashboard frontend for ams
- - `ams-server` is the backend server for ams
- - `ams-optimizer` provides default optimizer implementation
+ - `amoro-ams-api` contains ams thrift api and common interfaces
+ - `amoro-ams-dashboard` is the dashboard frontend for ams
+ - `amoro-ams-server` is the backend server for ams
+ - `amoro-ams-optimizer` provides default optimizer implementation
- `amoro-mixed-format` provides Mixed format implementation
- - `amoro-hive` integrates with Apache Hive and implements Mixed Hive format
- - `amoro-flink` provides Flink connectors for Mixed format tables (use
amoro-flink-runtime for a shaded version)
- - `amoro-spark` provides Spark connectors for Mixed format tables (use
amoro-spark-runtime for a shaded version)
- - `amoro-trino` provides Trino connectors for Mixed format tables
+ - `amoro-mixed-format-hive` integrates with Apache Hive and implements
Mixed Hive format
+ - `amoro-mixed-format-flink` provides Flink connectors for Mixed format
tables (use amoro-flink-runtime for a shaded version)
+ - `amoro-mixed-format-spark` provides Spark connectors for Mixed format
tables (use amoro-spark-runtime for a shaded version)
+ - `amoro-mixed-format-trino` provides Trino connectors for Mixed format
tables
## Building
-Amoro is built using Maven with Java 1.8 and Java 17(only for
`mixed-format/trino` module).
+Amoro is built using Maven with Java 1.8 and Java 17(only for
`amoro-mixed-format/amoro-mixed-format-trino` module).
* To build Trino module need config `toolchains.xml` in `${user.home}/.m2/`
dir, the content is
@@ -133,15 +132,16 @@ Amoro is built using Maven with Java 1.8 and Java 17(only
for `mixed-format/trin
* To invoke a build and run tests: `mvn package -P toolchain`
* To skip tests: `mvn -DskipTests package -P toolchain`
-* To package without trino module and JAVA 17 dependency: `mvn clean package
-DskipTests -pl '!mixed-format/trino'`
+* To package without trino module and JAVA 17 dependency: `mvn clean package
-DskipTests -pl '!amoro-mixed-format/amoro-mixed-format-trino'`
* To build with hadoop 2.x(the default is 3.x) `mvn clean package -DskipTests
-Dhadoop=v2`
* To indicate Flink version for optimizer (the default is 1.18.1): `mvn clean
package -Dflink-optimizer.flink-version=1.15.4`. If the version of Flink is
below 1.15.0, you also need to add the `-Pflink-pre-1.15` parameter: `mvn clean
package -Pflink-pre-1.15 -Dflink-optimizer.flink-version=1.14.6`.
`mvn clean package -Pflink-pre-1.15 -Dflink-optimizer.flink-version=1.14.6
-DskipTests`
>Spotless is skipped by default in `trino` module. So if you want to perform
>checkstyle when building `trino` module, you must be in a Java 17 environment.
-* To invoke a build include `mixed-format/trino` module in Java 17
environment: `mvn clean package -DskipTests -P trino-spotless`
-* To only build `mixed-format/trino` and its dependent modules in Java 17
environment: `mvn clean package -DskipTests -P trino-spotless -pl
'mixed-format/trino' -am`
+* To invoke a build include `amoro-mixed-format/amoro-mixed-format-trino`
module in Java 17 environment: `mvn clean package -DskipTests -P trino-spotless`
+* To only build `amoro-mixed-format/amoro-mixed-format-trino` and its
dependent modules in Java 17 environment: `mvn clean package -DskipTests -P
trino-spotless -pl 'amoro-mixed-format/amoro-mixed-format-trino' -am`
+
## Quickstart
Visit
[https://amoro.apache.org/quick-demo/](https://amoro.apache.org/quick-demo/) to
quickly
@@ -165,4 +165,4 @@ Made with [contrib.rocks](https://contrib.rocks).
## Star History
-[](https://star-history.com/#apache/amoro&Date)
\ No newline at end of file
+[](https://star-history.com/#apache/amoro&Date)
