-
-
Notifications
You must be signed in to change notification settings - Fork 148
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
Add peer awareness design document #139
Conversation
Codecov Report
@@ Coverage Diff @@
## master #139 +/- ##
=======================================
Coverage 58.59% 58.59%
=======================================
Files 27 27
Lines 2968 2968
=======================================
Hits 1739 1739
Misses 1056 1056
Partials 173 173 Continue to review full report at Codecov.
|
3580618
to
2134b2c
Compare
2134b2c
to
dec9073
Compare
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.
This is really cool!
It seems to be well written for easy understanding. I gave some opinions, so please check.
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.
In my opinion, this design document is great, simple and easy to understand.
For design document I think we can introduce more solid and consistent structures (especially later when some collaborator/contributor want to convey their ideas for enhancing yorkie with more features). I thought a good reference for this would be the KEP (Kubernetes Enchancement Proposal), e.g. this one.
0f54e63
to
22d38cd
Compare
22d38cd
to
71565d5
Compare
@dc7303, @habibrosyad Thank you for your review. I adjusted the section to reflect your comments. Also, @dc7303 commented that the first document will be referenced in future documents, so it's a good idea to handle it carefully. So I added a template too. |
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 👍 I think the written template and the peer-awareness.md
document are appropriate as our first design document.
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.
Thank you for your work! The design document and template are awesome and easy to understand! Also, I was able to learn about peer-awareness
!
What this PR does / why we need it:
Writing a design document for Peer Awareness.
Which issue(s) this PR fixes:
Fixes #48
Special notes for your reviewer:
Does this PR introduce a user-facing change?:
Additional documentation:
Checklist: