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

Configuration step for notifications config and subscriptions #22

Merged
merged 6 commits into from
Dec 12, 2024

Conversation

swrichards
Copy link
Contributor

No description provided.

@swrichards swrichards force-pushed the feature/setup-configuration-with-subscriptions branch 4 times, most recently from 267a42c to 1bd8e55 Compare December 11, 2024 17:12
@swrichards swrichards force-pushed the feature/setup-configuration-with-subscriptions branch 2 times, most recently from 3ad1c63 to 34b525c Compare December 11, 2024 17:18
@swrichards swrichards marked this pull request as ready for review December 12, 2024 08:24
@swrichards swrichards requested a review from stevenbal December 12, 2024 08:24
@swrichards swrichards requested a review from SonnyBA December 12, 2024 08:25
Copy link
Collaborator

@stevenbal stevenbal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor remarks regarding docs, looks good otherwise 👍

docs/setup_config.rst Outdated Show resolved Hide resolved
docs/setup_config.rst Outdated Show resolved Hide resolved
@swrichards swrichards force-pushed the feature/setup-configuration-with-subscriptions branch from fa58cc7 to 59b4d2b Compare December 12, 2024 09:15
# Note the order: NotificationSubscriptionConfigurationStep expects a notification service
# to have been configured by NotificationConfigurationStep
"notifications_api_common.contrib.setup_configuration.steps.NotificationConfigurationStep"
"notifications_api_common.contrib.setup_configuration.steps.NotificationSubscriptionConfigurationStep"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"notifications_api_common.contrib.setup_configuration.steps.NotificationSubscriptionConfigurationStep"
"notifications_api_common.contrib.setup_configuration.steps.NotificationSubscriptionConfigurationStep" # Optional

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure it makes sense to add this. Steps are inherently optional (they're ignored unless explicitly enabled). Configuring this is just about having the capability to use the step. More generally, all steps are inherently optional, you're not forced to use them at all (and with dependencies you can take care of dependencies manually as well).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in the context of setting up notifications for your project through django-setup-configuration (e.g not manually providing data or loading in fixtures) the NotificationSubscriptionConfigurationStep step is optional (but requires NotificationConfigurationStep) and the NotificationConfigurationStep is required (again, assuming you only want to use django-setup-configuration). Not all projects will use the NotificationSubscriptionConfigurationStep and the current documentation might give the impression that they will have to.

If this discussion is preventing you from merging the PR, then I would say go ahead and merge it 👍

@swrichards swrichards force-pushed the feature/setup-configuration-with-subscriptions branch from 59b4d2b to 57363d4 Compare December 12, 2024 10:49
@swrichards swrichards merged commit e4f138e into main Dec 12, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants