docs: update events how to

openedx · Jul 24, 2023 · d466aef · d466aef
1 parent 7abb70e
commit d466aef
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/docs/how-tos/adding-events-to-event-bus.rst b/docs/how-tos/adding-events-to-event-bus.rst
@@ -22,9 +22,10 @@ In the producing/host application, include ``openedx_events`` in ``INSTALLED_APP
    # .. setting_name: EVENT_BUS_PRODUCER_CONFIG
    # .. setting_default: {}
    # .. setting_description: Dictionary of event_types mapped to lists of dictionaries containing topic related configuration.
-   #    Each topic configuration dictionary contains a flag called `enabled` denoting whether the event will be
-   #    published to the topic, topic/stream name called `topic` where the event will be pushed to,
-   #    `event_key_field` which is a period-delimited string path to event data field to use as event key.
+   #    Each topic configuration dictionary contains
+   #    * a topic/stream name called `topic` where the event will be pushed to.
+   #    * a flag called `enabled` denoting whether the event will be published to the topic.
+   #    * `event_key_field` which is a period-delimited string path to event data field to use as event key.
    #    Note: The topic names should not include environment prefix as it will be dynamically added based on
    #    EVENT_BUS_TOPIC_PREFIX setting.
    EVENT_BUS_PRODUCER_CONFIG = {