[DOC] Update README.md by philo-he · Pull Request #8444 · apache/gluten

philo-he · 2025-01-07T06:03:11Z

Add ASF slack channel.
Add two companies that contributed to the development.
Rephrase the statement.
Remove unnecessary part and remove repetition.

github-actions · 2025-01-07T06:03:27Z

Thanks for opening a pull request!

Could you open an issue for this pull request on Github 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

FelixYBW · 2025-01-07T20:47:13Z

-### 3.2.1 Build and install Gluten with Velox backend
+There are two ways to acquire Gluten jar.
+
+# 3.1 Use Released Jar (only applicable to Velox backend)


"currently only applicable to Velox backend"

FelixYBW · 2025-01-07T20:47:37Z

+# 3.1 Use Released Jar (only applicable to Velox backend)

-If you want to use Gluten **Velox** backend, see [Build with Velox](./docs/get-started/Velox.md) to build and install the necessary libraries.
+Please download a tar package [here](https://downloads.apache.org/incubator/gluten/), then extract out Gluten jar from it.


Is the jar build staticly? can the jar be used on any OS? I don't think so. If so let's put the OS where the jar is built.

@FelixYBW, just confirmed with Weiting. The published release jar was generated by static build.

Even it's static built, it can still be used on the OS where it's built. Because it still depends on libc etc. which is different in different OS. We need to put the OSes we confirmed it can run on.

FelixYBW · 2025-01-07T20:50:00Z

@@ -63,58 +66,42 @@ There are several key components in Gluten:

 # 3 How to Use


Change it as "User Guide"

FelixYBW · 2025-01-07T20:51:08Z

 # 3 How to Use

-There are two ways to use Gluten.
-


Add the supported Spark versions (including minor version) and OS. Highlight that with static build we support all the OS types.

FelixYBW · 2025-01-07T20:56:19Z

+# 7 Acknowledgements

-# 8 Thanks to our contributors
+Gluten was initiated by Intel and Kyligence in 2022. Several companies are also actively participating in the development, such as BIGO, Meituan, Alibaba Cloud, NetEase, Baidu, Microsoft, etc.


Add IBM here.

@srinivasst would like to add "Google" here?

FelixYBW · 2025-01-07T20:57:20Z

 ## 4.1 Community

-Gluten successfully joined Apache Incubator since March'24. We welcome developers and users who are interested in Gluten project. Here are several ways to contact us:
+Gluten successfully became Apache incubator project in March'24. We welcome all developers and users who are interested in this project. Here are several ways to contact us:


Add the community mail list here:

* For community activity: dev@gluten.apache.org
* For code repository activity: commits@gluten.apache.org

Ignore it. Just noted the mailing lists section below

FelixYBW · 2025-01-08T19:09:12Z

@philo-he can you add the slack channel as well?

ASF workspace invite link (https://join.slack.com/t/the-asf/shared_invite/zt-2x74bfj6u-_3mH6Njlq6lZoIAZKNsutw))

Then search "incubator-gluten“ channel

zhztheplayer · 2025-01-09T03:35:58Z

@philo-he can you add the slack channel as well?

ASF workspace invite link (https://join.slack.com/t/the-asf/shared_invite/zt-2x74bfj6u-_3mH6Njlq6lZoIAZKNsutw))

Then search "incubator-gluten“ channel

For the slack channels (as well as other chat rooms), I recommend to lower the importance of them when users request for a way to ask questions or discuss about issues. Could encourage them to use GitHub or Apache mailing list more since they are more public and can be indexed by search engines. Do you guys have related thoughts?

cc @zhouyuan @weiting-chen

FelixYBW · 2025-01-09T07:28:47Z

@philo-he can you add the slack channel as well?
ASF workspace invite link (join.slack.com/t/the-asf/shared_invite/zt-2x74bfj6u-_3mH6Njlq6lZoIAZKNsutw))
Then search "incubator-gluten“ channel

For the slack channels (as well as other chat rooms), I recommend to lower the importance of them when users request for a way to ask questions or discuss about issues. Could encourage them to use GitHub or Apache mailing list more since they are more public and can be indexed by search engines. Do you guys have related thoughts?

cc @zhouyuan @weiting-chen

They are complementary each other, not replace each other. Let's put the link on home page

zhztheplayer · 2025-01-09T08:19:23Z

@philo-he can you add the slack channel as well?
ASF workspace invite link (join.slack.com/t/the-asf/shared_invite/zt-2x74bfj6u-_3mH6Njlq6lZoIAZKNsutw))
Then search "incubator-gluten“ channel

For the slack channels (as well as other chat rooms), I recommend to lower the importance of them when users request for a way to ask questions or discuss about issues. Could encourage them to use GitHub or Apache mailing list more since they are more public and can be indexed by search engines. Do you guys have related thoughts?
cc @zhouyuan @weiting-chen

They are complementary each other, not replace each other. Let's put the link on home page

I will be fine with adding a Slack link to documentation, since Slack's still open to all users so worth try with. Do you think we can add a note around the link to remind user that use of GitHub and Apache mailing list is encouraged?

E.g.,

* Slack channel: join.slack.com/...
  Note: Slack channel should only be used for informal chats. It's encouraged to use GitHub / Mailing list for raising issues or technical discussions.

FelixYBW · 2025-01-09T17:01:11Z

I will be fine with adding a Slack link to documentation, since Slack's still open to all users so worth try with. Do you think we can add a note around the link to remind user that use of GitHub and Apache mailing list is encouraged?

We needn't. We should encourage user use github issues instead of mailing. Many companies use Slack more than mails now.

philo-he · 2025-01-10T06:34:26Z

@FelixYBW, @zhztheplayer, if you have any other comment, please let me know.

FelixYBW · 2025-01-10T16:06:40Z

Looks good. @baibaichen @zzcclp Would you take a look?

zzcclp

+1

github-actions bot added the DOCS label Jan 7, 2025

FelixYBW reviewed Jan 7, 2025

View reviewed changes

philo-he force-pushed the update-doc branch 2 times, most recently from 0df443e to 0a4e6fa Compare January 10, 2025 06:06

philo-he added 3 commits January 10, 2025 14:24

Initial

0d622d0

Fix comment

e67a46f

Update

d712354

philo-he force-pushed the update-doc branch from 0a4e6fa to d712354 Compare January 10, 2025 06:26

philo-he marked this pull request as ready for review January 10, 2025 06:26

philo-he changed the title ~~[DOC] Update document~~ [DOC] Update README.md Jan 10, 2025

zhztheplayer approved these changes Jan 10, 2025

View reviewed changes

Fix comment

c7f9788

philo-he force-pushed the update-doc branch from d7c87ff to c7f9788 Compare January 10, 2025 07:02

FelixYBW approved these changes Jan 10, 2025

View reviewed changes

zzcclp approved these changes Jan 11, 2025

View reviewed changes

Fix comment

648b132

philo-he merged commit adf092d into apache:main Jan 13, 2025

		@@ -63,58 +66,42 @@ There are several key components in Gluten:

		# 3 How to Use

Conversation

philo-he commented Jan 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FelixYBW commented Jan 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zhztheplayer commented Jan 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FelixYBW commented Jan 9, 2025

Uh oh!

zhztheplayer commented Jan 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FelixYBW commented Jan 9, 2025

Uh oh!

philo-he commented Jan 10, 2025

Uh oh!

FelixYBW commented Jan 10, 2025

Uh oh!

zzcclp left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

philo-he commented Jan 7, 2025 •

edited

Loading

FelixYBW commented Jan 8, 2025 •

edited

Loading

zhztheplayer commented Jan 9, 2025 •

edited

Loading

zhztheplayer commented Jan 9, 2025 •

edited

Loading