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

docs: online filter documentation #2516

Merged
merged 4 commits into from
Jan 17, 2023

Conversation

BiswaViraj
Copy link
Contributor

What change does this PR introduce?

Added the documentation for the online filters and its working mechanism

Why was this change needed?

Other information (Screenshots)

@linear
Copy link

linear bot commented Jan 17, 2023

NV-1482 Documentation

  • How the online mechanism works behind the scene
  • How it can be enabled and monitored on activity feed
  • BONUS: example case for why and when to consider implementation.

@BiswaViraj BiswaViraj self-assigned this Jan 17, 2023
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 17, 2023
docs/docs/platform/step-filter.md Outdated Show resolved Hide resolved
docs/docs/platform/step-filter.md Outdated Show resolved Hide resolved

The online filter feature can be used to determine if a subscriber is online right now or if the subscriber was online within a specific time period.

- To determine if a subscriber is online right now, Novu checks the value of the `isOnline` field. If `isOnline` is `true`, the subscriber is online, otherwise the subscriber is offline.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

", otherwise when the isOnline is false the subscriber is considered offline."

Not sure if we should say that the subscriber might not have these fields set at the beginning, and if not we won't deliver a message, because we don't know whether he is online or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think once a subscriber is added to the system and it might not have those fields, technically the subscriber should be considered offline, until the subscriber logs in.

Copy link
Contributor

@LetItRock LetItRock Jan 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BiswaViraj I don't think that we can say that, because actually, he could be online at that time, so we don't know. I mean I'm talking about the old ones.

docs/docs/platform/step-filter.md Outdated Show resolved Hide resolved
docs/docs/platform/step-filter.md Outdated Show resolved Hide resolved
@BiswaViraj
Copy link
Contributor Author

Thanks @LetItRock for the suggestions 🚀

@BiswaViraj BiswaViraj merged commit abc20dd into nv-1441-is-online-filters-feature Jan 17, 2023
@BiswaViraj BiswaViraj deleted the nv-1482-documentation branch January 17, 2023 17:48
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.

None yet

2 participants