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

Document the mail.templates_basepath setting. #2931

Merged
merged 1 commit into from
Feb 7, 2019

Conversation

bowlofeggs
Copy link
Contributor

Signed-off-by: Randy Barlow randy@electronsweatshop.com

@bowlofeggs bowlofeggs added the Docs Issues pertaining to Bodhi's documentation label Jan 15, 2019
@bowlofeggs bowlofeggs requested a review from a team as a code owner January 15, 2019 16:00
production.ini Outdated
@@ -126,6 +126,11 @@ use = egg:bodhi-server
# domain for generated message IDs
# message_id_email_domain = admin.fedoraproject.org

# Where to search for e-mail templates. Eash release has an attribute that defines the name of a
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just small typo: Eash

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, fixed!

@bowlofeggs bowlofeggs force-pushed the mail_templates_setting branch 2 times, most recently from 7d066d3 to a7a1d3a Compare January 16, 2019 12:20
Copy link
Member

@pypingou pypingou left a comment

Choose a reason for hiding this comment

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

One question, otherwise looks fine :)

production.ini Outdated
@@ -126,6 +126,11 @@ use = egg:bodhi-server
# domain for generated message IDs
# message_id_email_domain = admin.fedoraproject.org

# Where to search for e-mail templates. Each release has an attribute that defines the name of a
Copy link
Member

Choose a reason for hiding this comment

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

Would it be worth documenting which attribute that is?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pypingou I'm applying this patch to document that attribute:

diff --git a/production.ini b/production.ini
index b2e57d9e..891bd1f8 100644
--- a/production.ini
+++ b/production.ini
@@ -126,8 +126,9 @@ use = egg:bodhi-server
 # domain for generated message IDs
 # message_id_email_domain = admin.fedoraproject.org

-# Where to search for e-mail templates. Each release has an attribute that defines the name of a
-# mail template, and Bodhi will look in the path defined by this setting to find the named template.
+# Where to search for e-mail templates. Each release has a mail_template attribute that defines the
+# name of a mail template, and Bodhi will look in the path defined by this setting to find the named
+# template.
 # mail.templates_basepath = bodhi:server/email/templates/

Copy link
Member

Choose a reason for hiding this comment

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

Looks good to me, thanks :)

Signed-off-by: Randy Barlow <randy@electronsweatshop.com>
@bowlofeggs bowlofeggs merged commit 330c443 into fedora-infra:develop Feb 7, 2019
@bowlofeggs bowlofeggs deleted the mail_templates_setting branch February 7, 2019 13:33
@bowlofeggs
Copy link
Contributor Author

This patch is planned for inclusion in the upcoming 4.0.0 release: #3221

@bowlofeggs
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Issues pertaining to Bodhi's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants