Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
docs/reference/event-types.md|135 col 5| [Replicated.Headings] 'Release Created' should use sentence case.
docs/reference/event-types.md|137 col 20| [Replicated.Passive] In general, use active voice instead of passive voice ('is created').
docs/reference/event-types.md|139 col 5| [Replicated.Headings] 'Release Promoted' should use sentence case.
docs/reference/event-types.md|141 col 16| [Replicated.Passive] In general, use active voice instead of passive voice ('is promoted').
docs/reference/event-types.md|143 col 5| [Replicated.Headings] 'Release Demoted (Unpublished)' should use sentence case.
docs/reference/event-types.md|145 col 16| [Replicated.Passive] In general, use active voice instead of passive voice ('is demoted').
docs/reference/event-types.md|147 col 5| [Replicated.Headings] 'Release Assets Downloaded' should use sentence case.
docs/reference/event-types.md|173 col 5| [Replicated.Headings] 'Support Bundle Uploaded' should use sentence case.
docs/reference/event-types.md|175 col 23| [Replicated.Passive] In general, use active voice instead of passive voice ('is uploaded').
docs/reference/event-types.md|177 col 5| [Replicated.Headings] 'Support Bundle Analyzed' should use sentence case.
docs/reference/event-types.md|179 col 32| [Replicated.Passive] In general, use active voice instead of passive voice ('is completed').
docs/reference/webhooks.md|1 col 3| [Replicated.Headings] 'Webhook payload structure (Beta)' should use sentence case.
docs/reference/webhooks.md|51 col 9| [Replicated.Acronyms] Spell out 'ISO' on first use, if it's unfamiliar to the audience.
docs/reference/webhooks.md|62 col 168| [Replicated.PositionalLanguage] Avoid spacial and directional language like 'below'. Instead, use 'on this page', 'the following', or link to the section.
docs/reference/webhooks.md|109 col 84| [Replicated.Passive] In general, use active voice instead of passive voice ('is included').
docs/reference/webhooks.md|109 col 152| [Replicated.Passive] In general, use active voice instead of passive voice ('is set').
docs/reference/webhooks.md|115 col 57| [Vale.Spelling] Did you really mean 'webhok'?
docs/reference/webhooks.md|117 col 6| [Replicated.Headings] 'Release Assets Downloaded events' should use sentence case.
docs/vendor/event-notifications-webhooks.mdx|20 col 52| [Replicated.Passive] In general, use active voice instead of passive voice ('is configured').
docs/vendor/event-notifications-webhooks.mdx|27 col 56| [Replicated.Passive] In general, use active voice instead of passive voice ('is signed').
docs/vendor/event-notifications-webhooks.mdx|27 col 71| [Replicated.Acronyms] Spell out 'HMAC' on first use, if it's unfamiliar to the audience.
docs/vendor/event-notifications-webhooks.mdx|28 col 47| [Replicated.Passive] In general, use active voice instead of passive voice ('are included').
docs/vendor/event-notifications-webhooks.mdx|29 col 49| [Replicated.Acronyms] Spell out 'RFC' on first use, if it's unfamiliar to the audience.
docs/vendor/event-notifications-webhooks.mdx|29 col 104| [Replicated.Passive] In general, use active voice instead of passive voice ('are blocked').
docs/vendor/event-notifications-webhooks.mdx|35 col 30| [Vale.Spelling] Did you really mean 'ngrok'?
docs/vendor/event-notifications-webhooks.mdx|41 col 14| [Vale.Spelling] Did you really mean 'ngrok'?
docs/vendor/event-notifications-webhooks.mdx|49 col 14| [Vale.Spelling] Did you really mean 'ngrok'?
docs/vendor/event-notifications-webhooks.mdx|49 col 77| [Replicated.Passive] In general, use active voice instead of passive voice ('was received').
docs/vendor/event-notifications-webhooks.mdx|114 col 15| [Replicated.Passive] In general, use active voice instead of passive voice ('are encrypted').
docs/vendor/event-notifications-webhooks.mdx|114 col 160| [Replicated.Passive] In general, use active voice instead of passive voice ('are included').
docs/vendor/event-notifications.mdx|7 col 382| [Replicated.Passive] In general, use active voice instead of passive voice ('are queued').
docs/vendor/event-notifications.mdx|7 col 396| [Replicated.Acronyms] Spell out 'SQS' on first use, if it's unfamiliar to the audience.
docs/vendor/event-notifications.mdx|7 col 443| [Replicated.Passive] In general, use active voice instead of passive voice ('are matched').
docs/vendor/event-notifications.mdx|19 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/event-notifications.mdx|25 col 122| [Replicated.Passive] In general, use active voice instead of passive voice ('is evaluated').
docs/vendor/event-notifications.mdx|27 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/event-notifications.mdx|27 col 199| [Replicated.Passive] In general, use active voice instead of passive voice ('is created').
docs/vendor/event-notifications.mdx|33 col 74| [Replicated.Acronyms] Spell out 'AND' on first use, if it's unfamiliar to the audience.
docs/vendor/event-notifications.mdx|39 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/event-notifications.mdx|39 col 109| [Replicated.Passive] In general, use active voice instead of passive voice ('is satisfied').
docs/vendor/event-notifications.mdx|41 col 12| [Vale.Spelling] Did you really mean 'licese'?
docs/vendor/event-notifications.mdx|43 col 116| [Replicated.Acronyms] Spell out 'AND' on first use, if it's unfamiliar to the audience.
docs/vendor/event-notifications.mdx|43 col 128| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/event-notifications.mdx|45 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/event-notifications.mdx|45 col 36| [Replicated.Passive] In general, use active voice instead of passive voice ('is supported').
docs/vendor/event-notifications.mdx|46 col 88| [Vale.Spelling] Did you really mean 'Unarchived'?
docs/vendor/event-notifications.mdx|73 col 170| [Replicated.Passive] In general, use active voice instead of passive voice ('be shared').
docs/vendor/event-notifications.mdx|73 col 227| [Replicated.Passive] In general, use active voice instead of passive voice ('is recorded').
docs/vendor/event-notifications.mdx|73 col 275| [Replicated.WordsToAvoid] Avoid using the word 'easily'.
docs/vendor/event-notifications.mdx|73 col 360| [Replicated.WordsToAvoid] Avoid using the word 'please'.
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
docs/vendor/event-notifications.mdx|9 col 22| [Replicated.Acronyms] Spell out 'SQS' on first use, if it's unfamiliar to the audience.
docs/vendor/event-notifications.mdx|9 col 69| [Replicated.Passive] In general, use active voice instead of passive voice ('are matched').
docs/vendor/event-notifications.mdx|17 col 162| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/event-notifications.mdx|23 col 107| [Replicated.Passive] In general, use active voice instead of passive voice ('is evaluated').
docs/vendor/event-notifications.mdx|25 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/event-notifications.mdx|25 col 199| [Replicated.Passive] In general, use active voice instead of passive voice ('is created').
docs/vendor/event-notifications.mdx|29 col 157| [Replicated.Acronyms] Spell out 'AND' on first use, if it's unfamiliar to the audience.
docs/vendor/event-notifications.mdx|37 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/event-notifications.mdx|37 col 109| [Replicated.Passive] In general, use active voice instead of passive voice ('is satisfied').
docs/vendor/event-notifications.mdx|39 col 12| [Vale.Spelling] Did you really mean 'licese'?
docs/vendor/event-notifications.mdx|41 col 116| [Replicated.Acronyms] Spell out 'AND' on first use, if it's unfamiliar to the audience.
docs/vendor/event-notifications.mdx|41 col 128| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/event-notifications.mdx|43 col 36| [Replicated.Passive] In general, use active voice instead of passive voice ('is supported').
docs/vendor/event-notifications.mdx|44 col 84| [Vale.Spelling] Did you really mean 'Unarchived'?
docs/vendor/event-notifications.mdx|73 col 170| [Replicated.Passive] In general, use active voice instead of passive voice ('be shared').
docs/vendor/event-notifications.mdx|73 col 227| [Replicated.Passive] In general, use active voice instead of passive voice ('is recorded').
docs/vendor/event-notifications.mdx|73 col 275| [Replicated.WordsToAvoid] Avoid using the word 'easily'.
docs/vendor/event-notifications.mdx|73 col 360| [Replicated.WordsToAvoid] Avoid using the word 'please'.
| files_ignore: | | ||
| docs/reference/kots-cli-* | ||
| docs/reference/replicated-cli-* | ||
| docs/reference/notifications-* |
There was a problem hiding this comment.
so vale doesn't fire for the new reference docs
| @@ -0,0 +1,181 @@ | |||
| # Event types and filters (Beta) | |||
There was a problem hiding this comment.
Reference topic that lists all the event types.
It's sparse now. We can add info about the event-specific filters available for each event (similar to how we have for Release Assets Downloads). Would be a good candidate for AI-generated docs
| @@ -0,0 +1,133 @@ | |||
| # Webhook payload structure (Beta) | |||
There was a problem hiding this comment.
Reference doc to explain the webhook payload structure and its fields. Could also decide that we don't want to actually list out all the payload fields here if it's redundant with the event filters lists
| - `team/notifications/events/read`: View notification history | ||
|
|
||
| For more information, see [Configure RBAC Policies](team-management-rbac-configuring#configure-a-custom-rbac-policy). | ||
| This topic describes how to create event notification subscriptions in the Replicated Vendor Portal. For more information about the Event Notifications (Beta) feature, see [About event notifications (Beta)](/vendor/event-notifications). |
There was a problem hiding this comment.
removed anything that wasn't how-to content or the examples. (Conceptual info went to the overview, and reference material went to the new pages)
| # Configure and use webhooks (Beta) | ||
|
|
||
| This topic describes how to configure and use webhooks for Event Notifications. | ||
| This topic describes how to configure and use webhooks for event notifications. For more information about the Event Notifications (Beta) feature, see [About event notifications (Beta)](/vendor/event-notifications). |
There was a problem hiding this comment.
mainly just reordered this topic so that Configure a Slack webhook is at the top. Also removed the reference material and moved it to the new reference doc
| The Vendor Portal queues events to Amazon Simple Queue Service (SQS) for reliable processing, and matches notifications against your custom event filters in real time. You can receive notifications through email or webhook. For information about how to create and subscribe to event notifications, see [Create event notification subscriptions (Beta)](event-notifications-create). | ||
|
|
||
| Events are queued to SQS for reliable processing, and notifications are matched against event filters in real-time. Email notifications are sent through the email service that you configure. Webhook notifications include HMAC signatures for verification. | ||
| ## Events and filters |
There was a problem hiding this comment.
all the conceptual info about event types and filter logic goes here. mostly the same, except I split it out into more subheadings and added examples
|
|
||
| - Notification events generated are not included in the [Instance Bulk Data Export API](instance-data-export) | ||
| - It is possible to create a notification for some resource types, such as customers and support bundles, but not to access the notification linked asset due to your allowed user permissions. This is most likely to impact teams with [enterprise and custom RBAC policies](team-management-rbac-configuring). For example, someone with the [Sales RBAC role](team-management-rbac-configuring) can create a notification for a customer uploading a support bundle, but does not have permission to view the linked specific customer bundle due to their RBAC role permissions. | ||
| - The Release Assets Downloaded event might fire per chart or image if the customer pulls each separately as part of your installation instructions. Because release assets might be shared across many of your release versions, the Vendor Portal records the event at the chart/image level and does not associate the event with a specific release version. If you find this alert too noisy, reach out to us to further discuss your specific use case. |
There was a problem hiding this comment.
Because release assets might be shared across many of your release versions, the Vendor Portal records the event at the chart/image level and does not associate the event with a specific release version.
I edited this limitation for clarity. This is the original version: "As these assets can be shared across many release versions, the access event is recorded at the chart/image level and is not easily identifiable to a specific release version."
I wasn't quite sure what it meant by "is not easily identifiable", so worth reviewing my edit to make sure it's right
|
|
||
| Roles with write access (Admin, Support Engineer, Sales, or custom roles) can create and manage their own notifications. They can also view notifications created by others. | ||
|
|
||
| Only Admins can create and manage notifications created by other team members. |
There was a problem hiding this comment.
removed mentions of "team notifications" per https://replicated.slack.com/archives/CEEFDQURM/p1773949373011469
2 participants
About event notifications: Conceptual overview, conceptual info about event and filter logic, requirements, and limitations
Create notifications: how to create notifications and examples
(New) Event types and filter reference doc: Reference material for each supported event type
Configure webhooks: how-to info about setting up/tetsing webhooks
(New) Webhook payload structure reference doc: Reference material on the webhook payload structure and its fields