-
Notifications
You must be signed in to change notification settings - Fork 134
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.
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
Improve README #427
Improve README #427
Conversation
Codecov Report
@@ Coverage Diff @@
## master #427 +/- ##
============================================
- Coverage 58.41% 57.61% -0.81%
+ Complexity 1612 1393 -219
============================================
Files 195 173 -22
Lines 11063 9223 -1840
Branches 976 816 -160
============================================
- Hits 6463 5314 -1149
+ Misses 4221 3573 -648
+ Partials 379 336 -43 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One minor comments, I'm fine with other modifications.
README.md
Outdated
|
||
Coordinator will collect status of shuffle server and do the assignment for the job. | ||
Coordinator will collect the status of the shuffle server and do the assignment for the job. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about this?
Coordinator will collect the status of the shuffle server and calculate shuffle assignments for compute job/app based on various assignment strategy.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about "Coordinator will collect the status of shuffle servers and assign jobs based on some strategy."?
In addition, I have tweaked the following sentence:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks @kaijchen
1. Update the introduction section in README: * "compute engines" is changed to "distributed compute engines". * "MapReduce" is changed to "Apache Hadoop MapReduce". * Remove the "Total lines" badge, see [OSSInsight][1] for better insight. 2. Fix typos. [1]: https://ossinsight.io/analyze/apache/incubator-uniffle#lines-of-code-changed "apache/incubator-uniffle | OSSInsight" Improve the README. No. Preview: https://github.com/kaijchen/incubator-uniffle/tree/readme#apache-uniffle-incubating
What changes were proposed in this pull request?
Why are the changes needed?
Improve the README.
Does this PR introduce any user-facing change?
No.
How was this patch tested?
Preview: https://github.com/kaijchen/incubator-uniffle/tree/readme#apache-uniffle-incubating