diff --git a/docs/how-tos/add-event-bus-support-to-an-event.rst b/docs/how-tos/add-event-bus-support-to-an-event.rst index d6bd57b3..1283e194 100644 --- a/docs/how-tos/add-event-bus-support-to-an-event.rst +++ b/docs/how-tos/add-event-bus-support-to-an-event.rst @@ -19,7 +19,7 @@ By default, Open edX Events should be compatible with the Open edX Event Bus. Ho When adding support is not possible, do the following: - Add it to the ``KNOWN_UNSERIALIZABLE_SIGNALS`` list in the ``openedx_events/tooling.py`` file so the event bus ignores it. -- Add a ``warning`` in the event’s docstring to inform developers why the event is incompatible with the event bus. +- Add a ``warning`` in the event's docstring to inform developers why the event is incompatible with the event bus. If you don't add the event to the ``KNOWN_UNSERIALIZABLE_SIGNALS`` list, the CI/CD pipeline will fail because the missing Avro schema could not be generated for the :term:`Event Payload`. If you don't add a warning in the event's docstring, developers might try to send the event across services and encounter issues.