diff --git a/README.md b/README.md index e5be4ecebc..6478c2a28f 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,12 @@

- Documentation | QuickStart | Development + Documentation | QuickStart | Development

- CI - License + CI + License Slack

@@ -21,7 +21,8 @@ Apache Fluss (Incubating) is a streaming storage built for real-time analytics which can serve as the real-time data layer for Lakehouse architectures. -It bridges the gap between **data streaming** and **data Lakehouse** by enabling low-latency, high-throughput data ingestion and processing while seamlessly integrating with popular compute engines like **Apache Flink**, while Apache Spark, and StarRocks are coming soon. +It bridges the gap between **data streaming** and **data Lakehouse** by enabling low-latency, high-throughput data ingestion and processing while seamlessly integrating with popular compute engines like **Apache Flink**, while +Apache Spark, and StarRocks are coming soon. **Fluss (German: river, pronounced `/flus/`)** enables streaming data continuously converging, distributing and flowing into lakes, like a river 🌊 @@ -44,7 +45,7 @@ Prerequisites for building Apache Fluss: - Java 8 or 11 ```bash -git clone https://github.com/alibaba/fluss.git +git clone https://github.com/apache/fluss.git cd fluss ./mvnw clean package -DskipTests ``` @@ -53,10 +54,10 @@ Apache Fluss is now installed in `build-target`. The build command uses Maven Wr ## Contributing -Apache Fluss (Incubating) is open-source, and we’d love your help to keep it growing! Join the [discussions](https://github.com/alibaba/fluss/discussions), -open [issues](https://github.com/alibaba/fluss/issues) if you find a bug or request features, contribute code and documentation, - or help us improve the project in any way. All contributions are welcome! +Apache Fluss (Incubating) is open-source, and we’d love your help to keep it growing! Join the [discussions](https://github.com/apache/fluss/discussions), +open [issues](https://github.com/apache/fluss/issues) if you find a bug or request features, contribute code and documentation, +or help us improve the project in any way. All contributions are welcome! ## License -Apache Fluss (Incubating) project is licensed under the [Apache License 2.0](https://github.com/alibaba/fluss/blob/main/LICENSE). +Apache Fluss (Incubating) project is licensed under the [Apache License 2.0](https://github.com/apache/fluss/blob/main/LICENSE). diff --git a/website/community/dev/building.md b/website/community/dev/building.md index f977585576..30fdfa67d9 100644 --- a/website/community/dev/building.md +++ b/website/community/dev/building.md @@ -25,22 +25,17 @@ title: Building Fluss This page covers how to build Fluss from sources. -In order to build Fluss you need to get the source code by [cloning the git repository](https://github.com/alibaba/fluss). +In order to build Fluss you need to get the source code by [cloning the git repository](https://github.com/apache/fluss). -In addition, you need **Maven 3.8.6** and a **JDK** (Java Development Kit). Fluss requires **Java 8 or Java 11** to build. - -:::tip -- It is recommended to use JDK 1.8.3 if you're using Java 8 and encounter an error like `java.lang.NoSuchMethodError: 'java.nio.MappedByteBuffer java.nio.MappedByteBuffer.duplicate()'`. -- Setting the environment variable via `export JAVA_TOOL_OPTIONS="-XX:+UnlockExperimentalVMOptions"` is useful if you encounter an error `VM option 'UseG1GC' is experimental and must be enabled via -XX:+UnlockExperimentalVMOptions`. -::: +In addition, you need **Maven 3.8.6** and a **JDK** (Java Development Kit). Fluss requires **Java 11** to build. To clone from git, enter: ```bash -git clone git@github.com:alibaba/fluss.git +git clone git@github.com:apache/fluss.git ``` -If you want to build a specific release or release candidate, have a look at the existing tags using +If you want to build a specific release or release candidate, have a look at the existing tags using ```bash git tag -n