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'.
|
I like the changes overall and support moving forward with them. Had a few specific comments when looking through that I captured below. Event Types page This note on the Event Types feels out of place in the middle of custom metrics. It should be at the end or beginning of the instance section. my vote would be beginning Let's remove language like "Use this to track the revenue recognition milestone when a customer first retrieves your software." This is one way to define this. The vendor may also define it as EP invite or EP first access. So this isn't how everyone defines it. It's probably fine in the example from the other page, but here is sounds too definitive and it's not universally true. Preview is missing 3 new customer events, likely because they were added late in the week as you worked on this In case you look at UI before this is shipped, a clean up story being done now https://app.shortcut.com/replicated/story/135665/new-ep-invite-events-follow-up-improvements Webhook payload structure page I personally find this page a bit confusing. It's not obvious that this is a sample payload. It reads like it will always follow this example structure, and we don't explicitly call out that the payload is different for each individual event, and to reference in the in-product UI for what that exact payload will be (or send yourself a test event) I'm not sure we should have a specific callout for |
| 1. (Recommended) Enter a signing secret for HMAC signature verification. For more information, see [Verify Webhook Signatures](event-notifications-webhooks#verify-webhook-signatures). | ||
| 1. (Optional) Expand **Advanced configuration** to add custom HTTP headers for authenticating with your endpoint (for example, `Authorization: Bearer token`). For more information, see [About Adding Custom HTTP Headers](event-notifications-webhooks#custom-headers). | ||
| 1. Click **View example** to open the webhook payload preview modal and see the exact JSON payload structure your endpoint receives for the selected event types. Click **Copy payload** to copy the format to your clipboard. For more information, see [About the Webhook Payload Format](event-notifications-webhooks#payload-preview). | ||
| 1. (Recommended) Enter a signing secret for HMAC signature verification. For more information, see [Verify webhook signatures](event-notifications-webhooks#verify-webhook-signatures) in _Configure and test webhooks (Beta)_. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'HMAC' on first use, if it's unfamiliar to the audience.
Good catch. Bumped it up to the top of the Instance event types section
Done
Will add these and/or follow up with Star about them as part of a separate PR. Doesn't look like they are in the live docs site either.
Per https://replicated.slack.com/archives/C02BPJQQP28/p1774367055181969?thread_ts=1773957959.391809&cid=C02BPJQQP28, removed the webhook payload reference page. The Create notification procedure tells people where to find the payload |
3 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