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.

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

Merged
merged 2 commits into from
Jan 7, 2021
Merged

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Jan 3, 2021

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:

  • Added relevant tests or not required
  • Didn't break anything

@hackerwins hackerwins added wip 🏗 documentation 📔 Improvements or additions to documentation labels Jan 3, 2021
@hackerwins hackerwins requested a review from dc7303 January 3, 2021 12:58
@hackerwins hackerwins self-assigned this Jan 3, 2021
@codecov
Copy link

codecov bot commented Jan 3, 2021

Codecov Report

Merging #139 (71565d5) into master (b00cfe3) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b00cfe3...71565d5. Read the comment docs.

@hackerwins hackerwins force-pushed the design-peer-awareness branch 2 times, most recently from 3580618 to 2134b2c Compare January 4, 2021 13:01
@hackerwins hackerwins force-pushed the design-peer-awareness branch from 2134b2c to dec9073 Compare January 4, 2021 13:55
@hackerwins hackerwins assigned dc7303 and unassigned hackerwins Jan 4, 2021
Copy link
Member

@dc7303 dc7303 left a 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.

design/peer-awareness.md Outdated Show resolved Hide resolved
design/peer-awareness.md Outdated Show resolved Hide resolved
Copy link
Contributor

@habibrosyad habibrosyad left a 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.

design/peer-awareness.md Outdated Show resolved Hide resolved
@hackerwins hackerwins force-pushed the design-peer-awareness branch 3 times, most recently from 0f54e63 to 22d38cd Compare January 5, 2021 20:47
@hackerwins hackerwins force-pushed the design-peer-awareness branch from 22d38cd to 71565d5 Compare January 5, 2021 20:48
@hackerwins
Copy link
Member Author

@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.

@hackerwins hackerwins removed their assignment Jan 6, 2021
@hackerwins hackerwins requested a review from mojosoeun January 6, 2021 01:16
Copy link
Member

@dc7303 dc7303 left a 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.

design/peer-awareness.md Show resolved Hide resolved
Copy link
Member

@mojosoeun mojosoeun left a 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!

@hackerwins hackerwins merged commit 0b97a53 into master Jan 7, 2021
@hackerwins hackerwins deleted the design-peer-awareness branch January 7, 2021 07:35
jeonjonghyeok pushed a commit to jeonjonghyeok/yorkie that referenced this pull request Aug 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📔 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Introduce Peer Awareness
4 participants