From 66699e72e37751359489ca517f11d9fc1201082c Mon Sep 17 00:00:00 2001 From: Jenna Diop Date: Wed, 16 Oct 2024 09:55:32 +0200 Subject: [PATCH] feedback docs typo --- docs/usage/integrations.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/usage/integrations.md b/docs/usage/integrations.md index a4040ab5..c053deee 100644 --- a/docs/usage/integrations.md +++ b/docs/usage/integrations.md @@ -87,14 +87,13 @@ For users looking to create a custom invitation strategy, here’s what you need - **Django Signals**: We use Django signals to manage invitations. You can refer to the [Django signals documentation](https://docs.djangoproject.com/en/4.2/topics/signals/) for more information. -- **Registering on the Signal**: You need to register on the `get_invites signal`, which provides the incident object and expects to receive a list of users. +- **Registering on the Signal**: You need to register on the [`get_invites`][firefighter.incidents.signals.get_invites] signal, which provides the incident object and expects to receive a list of [`users`][firefighter.slack.models.user]. - **Signal Example**: You can check one of our [signals][firefighter.slack.signals.get_users] for a concrete example. -**Tips**: - The signal can be triggered during the creation and update of an incident. - - Invitations will only be sent once all signals have responded. It is advisable to avoid API calls and to store data in the database beforehand. +!!! note "Tips" + The signal can be triggered during the creation and update of an incident. + Invitations will only be sent once all signals have responded. It is advisable to avoid API calls and to store data in the database beforehand. ##### SOSes