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

fix: update subscriber docs #3404

Merged
merged 10 commits into from
May 20, 2023
Merged

fix: update subscriber docs #3404

merged 10 commits into from
May 20, 2023

Conversation

jainpawan21
Copy link
Member

@jainpawan21 jainpawan21 commented May 13, 2023

What change does this PR introduce?

Update Subscriber Docs

  • Add ahead of trigger and inline of trigger info
  • Add Few FAQ
  • Add Subscriber Response

Why was this change needed?

Other information (Screenshots)

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 13, 2023
@jainpawan21 jainpawan21 self-assigned this May 14, 2023
Copy link
Contributor

@p-fernandez p-fernandez left a comment

Choose a reason for hiding this comment

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

🌟

docs/docs/platform/subscribers.md Outdated Show resolved Hide resolved
docs/docs/platform/subscribers.md Outdated Show resolved Hide resolved
docs/docs/platform/subscribers.md Outdated Show resolved Hide resolved
docs/docs/platform/subscribers.md Outdated Show resolved Hide resolved
docs/docs/platform/subscribers.md Outdated Show resolved Hide resolved
docs/docs/platform/subscribers.md Outdated Show resolved Hide resolved

## Delete a subscriber

To stop a subscriber from receiving notifications, you can delete the subscriber. This will hard delete the subscriber means you will not be able to access this subscriber later. You will have to create this subscriber again.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To stop a subscriber from receiving notifications, you can delete the subscriber. This will hard delete the subscriber means you will not be able to access this subscriber later. You will have to create this subscriber again.
To stop a subscriber from receiving notifications, you can delete the subscriber. This will hard delete the subscriber and means you will not be able to access this subscriber later. You will have to create this subscriber again.

Also we should explain what happens with the existing data (activity feed) when a hard delete happens.

Copy link
Member Author

Choose a reason for hiding this comment

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

@p-fernandez We have deleted property in subscriber response

I want to confirm are we hard deleting the subscriber in this API or not?

docs/docs/platform/subscribers.md Outdated Show resolved Hide resolved
docs/docs/platform/subscribers.md Show resolved Hide resolved
docs/docs/platform/subscribers.md Outdated Show resolved Hide resolved
@jainpawan21 jainpawan21 changed the base branch from next to main May 18, 2023 11:32
@jainpawan21 jainpawan21 merged commit 3fc31ca into main May 20, 2023
23 checks passed
@jainpawan21 jainpawan21 deleted the fix/update-subscriber-docs branch May 20, 2023 17:30
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

3 participants