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

SMTP workflow improvements #30

Merged
merged 5 commits into from
Feb 17, 2022
Merged

SMTP workflow improvements #30

merged 5 commits into from
Feb 17, 2022

Conversation

Ridhwana
Copy link
Contributor

@Ridhwana Ridhwana commented Feb 14, 2022

What type of PR is this? (check all applicable)

  • New File/Folder
  • Documentation Update

Description

This PR updates the documentation associated with this issue. We have made some improvements to the SMTP workflow, added reply_to and from email addresses for SMTP configuration and finally added a contact email to our config.

Here's a link to a draft post with more info.

Related Issues & Documents

forem/forem#16180

[optional] What gif best describes this PR or how it makes you feel?

alt_text

@@ -1,17 +0,0 @@
---
description: Modify email digest frequency.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We've removed the Email Digest Frequency Section and added it to the Emails section

@@ -1,17 +1,25 @@
---
description: Configure your Forem's SMTP server settings.
position: 16
description: Configure your Forem's Email Server Settings.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We've renamed SMTP Settings to a more human readable "Email Server Settings"


## Forem Cloud Clients

As a Forem Cloud client, we provide an email server managed by the Forem team. All settings are managed by us and the from and reply email addresses for all emails are set as noreply@forem.com.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We've added the ability for Forem Cloud Clients to override their Sendgrid settings and use custom SMTP settings if they wish to.


### Domain
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We've added a from and reply to email address

@@ -1,10 +1,21 @@
---
description: Set your community email address.
position: 5
description: Set your community email address and periodic email digest.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We've reworked the Emails section to remove the default email which was disabled anyways. We've added a contact email and moved the email digest field to the emails section

@@ -1,6 +1,6 @@
---
description: Define various monetization variables.
position: 0
position: 12
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These positions don't seem to matter as it seems that the nav links are getting sorted alphabetically. However, I just updated them anyways. Let me know if this was the wrong thing to do?

Copy link
Contributor

Choose a reason for hiding this comment

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

Absolutely fine to update these

---

# Newsletter

Newsletter settings allow you to integrate your Mailchimp newsletter audience with your Forem community members. Newsletters are sent from your Mailchimp account and are different from your [Forem Email Digests](https://admin.forem.com/docs/advanced-customization/config/email-digest-frequency).
Newsletter settings allow you to integrate your Mailchimp newsletter audience with your Forem community members. Newsletters are sent from your Mailchimp account and are different from your [Forem Email Digests](https://admin.forem.com/docs/advanced-customization/config/emails#periodic-email-digest).
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've updated all links for the digest email and email server settings to point to the correct updated pages

@@ -56,8 +56,8 @@ const NavigationSections = [
url: "docs/advanced-customization/config/authentication",
},
{
title: "Configure SMTP Settings",
url: "docs/advanced-customization/config/smtp-settings",
title: "Configure Email Server Settings (SMTP)",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Renamed the title and the link and also pointed all links to this updated URL


## Forem Cloud Clients

As a Forem Cloud client, we provide an email server managed by the Forem team. All settings are managed by us and the from and reply email addresses for all emails are set as noreply@forem.com.
Copy link
Contributor

Choose a reason for hiding this comment

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

I propose either

You are a Forem Cloud client. We provide Forem Cloud clients with an email server managed by the Forem team.

or

As a Forem Cloud client, you are provided with an email server managed by the Forem team.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated, thank you Ella ❤️

@ellativity ellativity marked this pull request as ready for review February 17, 2022 15:17
@ellativity ellativity merged commit f244375 into main Feb 17, 2022
@ellativity ellativity deleted the Ridhwana/SMTP-updates branch February 17, 2022 15:19
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.

2 participants