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

Update presence design document #609

Merged
merged 3 commits into from
Aug 18, 2023
Merged

Update presence design document #609

merged 3 commits into from
Aug 18, 2023

Conversation

chacha912
Copy link
Contributor

@chacha912 chacha912 commented Aug 16, 2023

What this PR does / why we need it:

Update design document for presence.
It contains information about the changes made in the following pull request.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

While working on the document, I think it is better to make the following changes. (I will address these changes through a separate pull request):

  • Change "documents" to "document" in DocEvent (since the WatchDocument API has been updated to operate on a single document: Add RemoveDocument API yorkie-js-sdk#480).
  • Rename doc.getPresences() to doc.getUsers() (as the returned value aligns more closely with user information, making this name easier to comprehend).

Does this PR introduce a user-facing change?:


Additional documentation:


Checklist:

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

@codecov
Copy link

codecov bot commented Aug 16, 2023

Codecov Report

Merging #609 (53ef2a0) into main (65c8164) will decrease coverage by 0.96%.
Report is 4 commits behind head on main.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##             main     #609      +/-   ##
==========================================
- Coverage   51.19%   50.24%   -0.96%     
==========================================
  Files          67       69       +2     
  Lines        7053     7314     +261     
==========================================
+ Hits         3611     3675      +64     
- Misses       2960     3147     +187     
- Partials      482      492      +10     
Files Changed Coverage Δ
server/backend/backend.go 0.00% <0.00%> (ø)

... and 11 files with indirect coverage changes

@krapie krapie added the documentation 📔 Improvements or additions to documentation label Aug 17, 2023
@chacha912 chacha912 marked this pull request as ready for review August 18, 2023 03:09
Copy link
Member

@hackerwins hackerwins 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 left a minor comment.

design/peer-awareness.md Outdated Show resolved Hide resolved
@hackerwins hackerwins merged commit 77b1508 into main Aug 18, 2023
1 check passed
@hackerwins hackerwins deleted the update-design-doc branch August 18, 2023 04:03
hackerwins pushed a commit that referenced this pull request Aug 18, 2023
* Update pub-sub design document

* Rename peer awareness to presence
Wu22e pushed a commit to Wu22e/yorkie that referenced this pull request Sep 3, 2023
* Update pub-sub design document

* Rename peer awareness to presence
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.

3 participants