Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add annotations for event bus settings #124

Closed
1 task done
Tracked by #183
robrap opened this issue Feb 1, 2023 · 2 comments
Closed
1 task done
Tracked by #183

Add annotations for event bus settings #124

robrap opened this issue Feb 1, 2023 · 2 comments
Assignees
Labels
event-bus Work related to the Event Bus.

Comments

@robrap
Copy link
Contributor

robrap commented Feb 1, 2023

AC:

  • Add annotation documentation for the rest of the settings in config.py.

Only one of the settings in config.py is annotated:

# .. setting_name: EVENT_BUS_TOPIC_PREFIX
# .. setting_default: None
# .. setting_description: If provided, add this as a prefix to any topic names (delimited by a hyphen)
# when either producing or consuming events. This can be used to support separation of environments,
# e.g. if multiple staging or test environments are sharing a cluster. For example, if the base topic
# name is "user-logins", then if EVENT_BUS_TOPIC_PREFIX=stage, the producer and consumer would instead
# work with the topic "stage-user-logins".
topic_prefix = getattr(settings, 'EVENT_BUS_TOPIC_PREFIX', None)

This ticket is for adding annotations for the rest of the settings in this file.
https://github.com/openedx/event-bus-kafka/blob/main/edx_event_bus_kafka/internal/config.py

We might want to link to the new annotations from:

Note: We could consider updating docs in this library to extract/publish these annotations, as is done in edx-platform. This could be part of this ticket or its own ticket.

@robrap robrap added the event-bus Work related to the Event Bus. label Feb 1, 2023
@robrap
Copy link
Contributor Author

robrap commented Feb 1, 2023

Should we do this now, or add to Future milestone?

@robrap robrap moved this to Todo in Arch-BOM Feb 1, 2023
@robrap robrap added this to Arch-BOM Feb 1, 2023
@robrap robrap moved this from Todo to Groomed in Arch-BOM Feb 2, 2023
@timmc-edx timmc-edx self-assigned this Feb 3, 2023
@timmc-edx timmc-edx moved this from Groomed to In Progress in Arch-BOM Feb 3, 2023
@timmc-edx timmc-edx added backlog Item is on a team's backlog or wish list. and removed backlog Item is on a team's backlog or wish list. labels Feb 9, 2023
@timmc-edx
Copy link
Contributor

timmc-edx commented Feb 28, 2023

Created #139 for followup.

@github-project-automation github-project-automation bot moved this from In Progress to Done in Arch-BOM Feb 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
event-bus Work related to the Event Bus.
Projects
None yet
Development

No branches or pull requests

2 participants