From fbf38cf5921e4bf494818aca78665b788b60eead Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Mon, 9 Dec 2024 12:54:25 +0100 Subject: [PATCH] docs: rewrite introduction to step-by-step avro schema generation guide --- docs/how-tos/adding-event-bus-support-to-an-event.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-tos/adding-event-bus-support-to-an-event.rst b/docs/how-tos/adding-event-bus-support-to-an-event.rst index 90650d8f..d1b4b438 100644 --- a/docs/how-tos/adding-event-bus-support-to-an-event.rst +++ b/docs/how-tos/adding-event-bus-support-to-an-event.rst @@ -124,7 +124,7 @@ If your :term:`Event Payload` contains only supported data types, you can skip t Step 4: Generate the Avro Schema -------------------------------- -As mentioned in the previous step, the serialization and deserialization of the :term:`Event Payload` is handled by the concrete event bus implementation with the help of methods implemented in this library. However, although openedx-events does not handles the serialization and deserialization of the :term:`Event Payload` directly, it ensures the payload of new events can be serialized and deserialized correctly by adding checks in the CI/CD pipeline for schema verification. To ensure this, you need to generate the Avro schema for the :term:`Event Payload`: +As mentioned in the previous step, the serialization and deserialization of the :term:`Event Payload` is handled by the concrete event bus implementation with the help of methods implemented in this library. However, although openedx-events does not handles the serialization and deserialization of the :term:`Event Payload` directly, it ensures the payload of new events can be serialized and deserialized correctly by adding checks in the CI/CD pipeline for schema verification. To ensure tests pass, you need to generate an Avro test schema for your new event's :term:`Event Payload`: 1. Run the following command to generate the Avro schema for the :term:`Event Payload`: