docs: refactor names for consistency in how-tos

openedx · Dec 19, 2024 · 187f16e · 187f16e
1 parent 41cda0f
commit 187f16e
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 367 deletions.
diff --git a/docs/concepts/event-bus.rst b/docs/concepts/event-bus.rst
@@ -119,7 +119,7 @@ How is the Open edX Event Bus Used?
 
 The event bus is used to broadcast Open edX Events to multiple services, allowing them to react to changes or actions in the system.
 
-We encourage you to review the :doc:`../reference/real-life-use-cases` page for examples of how the event bus is used in the Open edX ecosystem by the community. Also, see the :doc:`../how-tos/using-the-event-bus` guide to get start sending events to the event bus.
+We encourage you to review the :doc:`../reference/real-life-use-cases` page for examples of how the event bus is used in the Open edX ecosystem by the community. Also, see the :doc:`../how-tos/use-the-event-bus-to-broadcast-and-consume-events` guide to get start sending events to the event bus.
 
 .. _general_signal_handler: https://github.com/openedx/openedx-events/blob/main/openedx_events/apps.py#L16-L44
 .. _EventProducer: https://github.com/openedx/openedx-events/blob/main/openedx_events/event_bus/__init__.py#L71-L91

diff --git a/docs/concepts/openedx-events.rst b/docs/concepts/openedx-events.rst
@@ -75,7 +75,7 @@ How are Open edX Events used?
 
 As mentioned previously, developers can listen to Open edX Events by registering signal receivers from their Open edX Django plugins that respond to the emitted events or by using the :doc:`../concepts/event-bus` to send events to external services.
 
-For more information on using Open edX Events, refer to the :doc:`../how-tos/using-events` how-to guide. We also encourage you to explore the :doc:`../reference/real-life-use-cases` section for real-life examples of how Open edX Events are used by the community.
+For more information on using Open edX Events, refer to the :doc:`../how-tos/create-a-new-event` how-to guide. We also encourage you to explore the :doc:`../reference/real-life-use-cases` section for real-life examples of how Open edX Events are used by the community.
 
 .. _Django Signals Documentation: https://docs.djangoproject.com/en/4.2/topics/signals/
 .. _triggering the COURSE_ENROLLMENT_CREATED event: https://github.com/openedx/edx-platform/blob/master/common/djangoapps/student/models/course_enrollment.py#L777-L795

diff --git a/docs/how-tos/add-new-event-bus-concrete-implementation.rst b/docs/how-tos/add-new-event-bus-concrete-implementation.rst
@@ -1,5 +1,5 @@
-How to add a new concrete implementation of the event bus
-=========================================================
+Add a New Concrete Implementation of the Event Bus
+==================================================
 
 Context
 -------

diff --git a/docs/how-tos/adding-events-to-a-service.rst b/docs/how-tos/adding-events-to-a-service.rst
diff --git a/docs/how-tos/creating-new-events.rst b/docs/how-tos/creating-new-events.rst
diff --git a/docs/how-tos/index.rst b/docs/how-tos/index.rst
@@ -5,8 +5,7 @@ How-tos
    :maxdepth: 1
    :caption: Contents:
 
-   creating-new-events
-   adding-events-to-a-service
-   using-events
-   using-the-event-bus
+   create-a-new-event
+   consume-an-event
+   use-the-event-bus-to-broadcast-and-consume-events
    add-new-event-bus-concrete-implementation
diff --git a/docs/how-tos/using-events.rst b/docs/how-tos/using-events.rst