Skip to content

docs: add documentation for notifications feature #14478

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

Merged
merged 9 commits into from
Aug 30, 2024

Conversation

dannykopping
Copy link
Contributor

@dannykopping dannykopping commented Aug 29, 2024

Copy link
Collaborator

@stirby stirby left a comment

Choose a reason for hiding this comment

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

Going to add a little section towards the top about user preferences.

Notifications are sent by Coder in response to specific internal events, such as a workspace being deleted or a user
being created.

**Notifications are currently an experimental feature.**
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's call out the release explicitly until our docs have versioning.

**Notifications are currently an experimental feature initially released in [2.15.0](https://github.com/coder/coder/releases/tag/v2.15.0).**

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is causing CI to fail since the release is not yet present: https://github.com/coder/coder/actions/runs/10629250397/job/29465701530?pr=14478

We can ignore this failure and merge, or wait to merge until the release has been prepared.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We need it in main before we cut the tag for offline docs, let's just skip the link.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, removed in 6a6b903.

dannykopping and others added 5 commits August 30, 2024 09:28
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
@dannykopping dannykopping changed the title [WIP] notifications docs docs: add documentation for notifications feature Aug 30, 2024
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
@dannykopping dannykopping marked this pull request as ready for review August 30, 2024 08:25
Copy link
Member

@johnstcn johnstcn left a comment

Choose a reason for hiding this comment

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

Nice documentation 👍

Copy link
Member

@mtojek mtojek left a comment

Choose a reason for hiding this comment

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

Great documentation!

Signed-off-by: Danny Kopping <danny@coder.com>
@dannykopping dannykopping merged commit 043f4f5 into main Aug 30, 2024
28 checks passed
@dannykopping dannykopping deleted the dk/notification-docs branch August 30, 2024 15:30
@github-actions github-actions bot locked and limited conversation to collaborators Aug 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: write up docs for notifications
4 participants