Skip to content

Commit

Permalink
[DOC] Update release & configuration doc (#4910)
Browse files Browse the repository at this point in the history
  • Loading branch information
PHILO-HE authored Mar 11, 2024
1 parent e26a17f commit e47509a
Show file tree
Hide file tree
Showing 27 changed files with 145 additions and 125 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/dev_cron/issues_link.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ async function haveComment(github, context, pullRequestNumber, body) {
}

async function commentISSUESURL(github, context, pullRequestNumber, issuesID) {
const issuesURL = `https://github.com/oap-project/gluten/issues/${issuesID}`;
const issuesURL = `https://github.com/apache/incubator-gluten/issues/${issuesID}`;
if (await haveComment(github, context, pullRequestNumber, issuesURL)) {
return;
}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/dev_cron/title_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Thanks for opening a pull request!

Could you open an issue for this pull request on Github Issues?

https://github.com/oap-project/gluten/issues
https://github.com/apache/incubator-gluten/issues

Then could you also rename ***commit message*** and ***pull request title*** in the following format?

[GLUTEN-${ISSUES_ID}][COMPONENT]feat/fix: ${detailed message}

See also:

* [Other pull requests](https://github.com/oap-project/gluten/pulls/)
* [Other pull requests](https://github.com/apache/incubator-gluten/pulls/)

10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ please add at least one UT to ensure code quality and reduce regression issues f

Please update document for your proposed code change if necessary.

If a new config property is being introduced, please update [Configuration.md](https://github.com/oap-project/gluten/blob/main/docs/Configuration.md).
If a new config property is being introduced, please update [Configuration.md](https://github.com/apache/incubator-gluten/blob/main/docs/Configuration.md).

### Code Style

##### Java/Scala code style
Developer can import the code style setting to IDE and format Java/Scala code with spotless maven plugin. See [Java/Scala code style](https://github.com/oap-project/gluten/blob/main/docs/developers/NewToGluten.md#javascala-code-style).
Developer can import the code style setting to IDE and format Java/Scala code with spotless maven plugin. See [Java/Scala code style](https://github.com/apache/incubator-gluten/blob/main/docs/developers/NewToGluten.md#javascala-code-style).

##### C/C++ code style
There are some code style conventions need to comply. See [CppCodingStyle.md](https://github.com/oap-project/gluten/blob/main/docs/developers/CppCodingStyle.md).
There are some code style conventions need to comply. See [CppCodingStyle.md](https://github.com/apache/incubator-gluten/blob/main/docs/developers/CppCodingStyle.md).

For Velox backend, developer can just execute `dev/formatcppcode.sh` to format C/C++ code. It requires `clang-format-12`
installed in your development env.
Expand All @@ -68,7 +68,7 @@ You can execute a script to fix license header issue, as the following shows.
### Gluten CI

##### ClickHouse Backend CI
To check CI failure for CH backend, please log in with the public account/password provided [here](https://github.com/oap-project/gluten/blob/main/docs/get-started/ClickHouse.md#new-ci-system).
To check CI failure for CH backend, please log in with the public account/password provided [here](https://github.com/apache/incubator-gluten/blob/main/docs/get-started/ClickHouse.md#new-ci-system).
To re-trigger CH CI, please post the below comment on PR page:

`Run Gluten Clickhouse CI`
Expand All @@ -79,7 +79,7 @@ To check CI failure for Velox backend, please go into the GitHub action page fro
To see the perf. impact on Velox backend, you can comment `/Benchmark Velox` on PR page to trigger a pretest. The benchmark
(currently TPC-H) result will be posted after completed.

If some new dependency is required to be installed, you may need to do some change for CI docker at [this folder](https://github.com/oap-project/gluten/tree/main/tools/gluten-te).
If some new dependency is required to be installed, you may need to do some change for CI docker at [this folder](https://github.com/apache/incubator-gluten/tree/main/tools/gluten-te).

### Code Review

Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Gluten: Plugin to Double SparkSQL's Performance
# Apache Gluten (Incubating): A Middle Layer for Offloading JVM-based SQL Engines' Execution to Native Engines

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8452/badge)](https://www.bestpractices.dev/projects/8452)

*<b>This project is still under active development now, and doesn't have a stable release. Welcome to evaluate it.</b>*

# 1 Introduction
Expand Down Expand Up @@ -30,7 +32,7 @@ The basic rule of Gluten's design is that we would reuse spark's whole control f
## 1.3 Target User

Gluten's target user is anyone who wants to accelerate SparkSQL fundamentally. As a plugin to Spark, Gluten doesn't require any change for dataframe API or SQL query, but only requires user to make correct configuration.
See Gluten configuration properties [here](https://github.com/oap-project/gluten/blob/main/docs/Configuration.md).
See Gluten configuration properties [here](https://github.com/apache/incubator-gluten/blob/main/docs/Configuration.md).

## 1.4 References

Expand Down Expand Up @@ -72,7 +74,7 @@ spark-shell \
--conf spark.memory.offHeap.enabled=true \
--conf spark.memory.offHeap.size=20g \
--conf spark.shuffle.manager=org.apache.spark.shuffle.sort.ColumnarShuffleManager \
--jars https://github.com/oap-project/gluten/releases/download/v1.0.0/gluten-velox-bundle-spark3.2_2.12-ubuntu_20.04_x86_64-1.0.0.jar
--jars https://github.com/apache/incubator-gluten/releases/download/v1.0.0/gluten-velox-bundle-spark3.2_2.12-ubuntu_20.04_x86_64-1.0.0.jar
```

# 3.2 Custom Build
Expand Down Expand Up @@ -118,7 +120,7 @@ Please feel free to create Github issue for reporting bug or proposing enhanceme

## 4.3 Documentation

Currently, all gluten documents are held at [docs](https://github.com/oap-project/gluten/tree/main/docs). The documents may not reflect the latest designs. Please feel free to contact us for getting design details or sharing your design ideas.
Currently, all gluten documents are held at [docs](https://github.com/apache/incubator-gluten/tree/main/docs). The documents may not reflect the latest designs. Please feel free to contact us for getting design details or sharing your design ideas.

# 5 Performance

Expand Down
Loading

0 comments on commit e47509a

Please sign in to comment.