Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Split the client.md into four documents #1094

Closed
2 of 3 tasks
Tracked by #1092
, #2
...
jerqi opened this issue Aug 5, 2023 · 4 comments · Fixed by #1299
Closed
2 of 3 tasks
Tracked by #1092
, #2
...

[DOCS] Split the client.md into four documents #1094

jerqi opened this issue Aug 5, 2023 · 4 comments · Fixed by #1299
Assignees
@zivali
Labels
good first issue Good for newcomers

Comments

@jerqi
Copy link
Contributor

jerqi commented Aug 5, 2023

Code of Conduct

Search before asking

  • I have searched in the issues and found no similar issues.

Which parts of the documentation do you think need improvement?

The docs/client.md have common client's, Spark's, MapReduce's and Tez's configurations. We should split it into four documents.

Affects Version(s)

master

Improving the documentation

No response

Anything else

No response

Are you willing to submit PR?

  • Yes I am willing to submit a PR!
@jerqi jerqi changed the title [DOCS] Split the client.md to four documents [DOCS] Split the client.md into four documents Aug 5, 2023
@jerqi jerqi added the good first issue Good for newcomers label Aug 5, 2023
@jerqi jerqi mentioned this issue Aug 5, 2023
Open
17 tasks
@ASDasd341
Copy link

Let me help in this.

@jerqi
Copy link
Contributor Author

jerqi commented Aug 5, 2023

Thanks.

@gdrbacca gdrbacca mentioned this issue Oct 27, 2023
Open
17 tasks
@zivali
Copy link
Contributor

zivali commented Nov 3, 2023

Hi @jerqi, may I try this one?
Will try to preserve only shared configuration in client_guide.md and open three other subpages:

  • Deploy Spark Client Plugin & Configurations
  • Deploy MapReduce Client Plugin & Configurations
  • Deploy Tez Client Plugin & Configurations

@jerqi
Copy link
Contributor Author

jerqi commented Nov 3, 2023

Hi @jerqi, may I try this one? Will try to preserve only shared configuration in client_guide.md and open three other subpages:

  • Deploy Spark Client Plugin & Configurations
  • Deploy MapReduce Client Plugin & Configurations
  • Deploy Tez Client Plugin & Configurations

OK.

@jerqi jerqi assigned zivali and unassigned ASDasd341 Nov 3, 2023
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: Move client guide to a specific folder
e616a36
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: split spark client guide into separate file
ced42db
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: split mr client guide into separate file
76ae3ed
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: split tez client guide into separate file
18b4ed1
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: refine client guide
c897881
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: add license description
eec2f14
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: split tez client guide into separate file
0f28619
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: refine client guide
eda8bbd
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: add license description
76d2128
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: refine client guide
89a0e23
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: add license description
2e5fb7f
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: refine client guide
fcdcb38
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: add license description
a89669e
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: refine client guide
8191374
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: add license description
3978c7c
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: refine client guide
0d8850e
zivali added a commit to zivali/incubator-uniffle that referenced this issue Nov 5, 2023
@zivali
[apache#1094] docs: add license description
ff61e13
@zivali zivali mentioned this issue Nov 5, 2023
Merged
jerqi pushed a commit that referenced this issue Nov 6, 2023
@zivali
[#1094] docs: split client_guide.md (#1299)
59e08e5 
### What changes were proposed in this pull request?

- Modify client_guide.md to include only shared configurations
- Add three subpages to it for 3 different clients: spark, mapreduce, and tez

### Why are the changes needed?

Fix: #1094 

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

Modifying documentation only.

### Additional Notes
- Netty configs are found in [common/src/main/java/org/apache/uniffle/common/config/RssClientConf.java](https://github.com/apache/incubator-uniffle/blob/master/common/src/main/java/org/apache/uniffle/common/config/RssClientConf.java). I presume they are shared configurations.
- Remote Spill is available in Tez as well. Reference [commit](4f56e59) / [RssTezConfig.java](https://github.com/apache/incubator-uniffle/blob/master/client-tez/src/main/java/org/apache/tez/common/RssTezConfig.java)

Co-authored-by: Ziva Li <ziva.li@yahooinc.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zivali zivali

Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[#1094] docs: split client_guide.md zivali/incubator-uniffle
3 participants
@jerqi @zivali @ASDasd341