From 49f0842088116c99a2676429e96c0ce113a79039 Mon Sep 17 00:00:00 2001 From: Roni Choudhury Date: Mon, 22 Jul 2024 12:41:47 -0400 Subject: [PATCH 1/5] Retitle section --- docs/40_development.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/40_development.md b/docs/40_development.md index 8c9021f4..56815f7c 100644 --- a/docs/40_development.md +++ b/docs/40_development.md @@ -126,7 +126,7 @@ However, this is not strictly required. You can contribute using the standard fork-and-pull-request model, but under this workflow we will lose the benefit of those previews. -## Email Lists +## Email Services The project's email domain name services are managed via Terraform as AWS Route 53 entries. This allows the API server to send emails to users, etc. It also @@ -168,7 +168,7 @@ there. ### Why do incoming emails to dandiarchive.org look crazy? When a user emails help@dandiarchive.org or info@dandiarchive.org, those -messages are forwarded to dandi@mit.edu (see [above](#email-lists)) so that the +messages are forwarded to dandi@mit.edu (see [above](#email-services)) so that the dev team sees them. However, these emails arrive with a long, spammy-looking From address with a Heroku DNS domain; this seems to be an artifact of how mit.edu processes emails, and does not occur in general (e.g. messages sent From b8d2f3bdfe20bf82e67fa2794014ebc45ca09315 Mon Sep 17 00:00:00 2001 From: Roni Choudhury Date: Mon, 22 Jul 2024 12:42:52 -0400 Subject: [PATCH 2/5] Add intro section (plus a subheading for first section) --- docs/40_development.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/docs/40_development.md b/docs/40_development.md index 56815f7c..01c9ff62 100644 --- a/docs/40_development.md +++ b/docs/40_development.md @@ -128,10 +128,24 @@ those previews. ## Email Services -The project's email domain name services are managed via Terraform as AWS Route -53 entries. This allows the API server to send emails to users, etc. It also -means we need a way to forward incoming emails to the proper mailing list--this -is accomplished with a service called [ImprovMX](https://improvmx.com/). +DANDI Archive maintains several email services to implement the following +facilities: + +- **Public email.** Users of the archive can reach the developers for help or to + report problems by sending email to info@dandiarchive.org and + help@dandiarchive.org. These are "virtual" email addresses managed by DNS + entries. +- **Transactional email.** The Archive sends email to users to manage the signup + process and to inform about special situations, long running operations, etc. + such as registration reject/approval, Dandiset embargo and unembargo, changes to + ownership, etc. These are sent via Amazon Simple Email Service (SES), + programmatically from the Archive code. +- **Mass email.** The maintainers of the Archive infrequently send + mass email to all users of the Archive to inform about downtime + or other notifications of mass appeal. This function is managed through a + Mailchimp account that requires special procedures to keep it up to date. + +### DNS Entries for public email addresses The email addresses info@dandiarchive.org and help@dandiarchive.org are advertised to users as general email addresses to use to ask for information or From a8c1278e969e57c796ee8420d1fffba42a3df49f Mon Sep 17 00:00:00 2001 From: Roni Choudhury Date: Mon, 22 Jul 2024 12:43:50 -0400 Subject: [PATCH 3/5] Remix existing content for clarity --- docs/40_development.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/40_development.md b/docs/40_development.md index 01c9ff62..422a6d65 100644 --- a/docs/40_development.md +++ b/docs/40_development.md @@ -149,10 +149,11 @@ facilities: The email addresses info@dandiarchive.org and help@dandiarchive.org are advertised to users as general email addresses to use to ask for information or -help; both of them are forwarded to dandi@mit.edu, a mailing list containing the -leaders and developers of the project. The forwarding is done by the ImprovMX -service, and more such email addresses can be created as needed within that -service. +help. These are managed via Terraform as AWS Route 53 MX entries. We use +[ImprovMX](https://improvmx.com/) to forward emails sent to these addresses to +dandi@mit.edu, a mailing list containing the leaders and developers of the +project. (Other virtual addresses within the dandiarchive.org domain can be +created as needed.) If you need the credentials for logging into ImprovMX, speak to Roni Choudhury (). From e02a0e601b8898c6f4983c8c1abae8e2727084b1 Mon Sep 17 00:00:00 2001 From: Roni Choudhury <2903332+waxlamp@users.noreply.github.com> Date: Mon, 12 Aug 2024 11:28:01 -0400 Subject: [PATCH 4/5] Capitalize "Archive" Co-authored-by: Kabilar Gunalan --- docs/40_development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/40_development.md b/docs/40_development.md index 422a6d65..405f8c68 100644 --- a/docs/40_development.md +++ b/docs/40_development.md @@ -131,7 +131,7 @@ those previews. DANDI Archive maintains several email services to implement the following facilities: -- **Public email.** Users of the archive can reach the developers for help or to +- **Public email.** Users of the Archive can reach the developers for help or to report problems by sending email to info@dandiarchive.org and help@dandiarchive.org. These are "virtual" email addresses managed by DNS entries. From c292f545e53103470ad9c182d61f5c973de40d88 Mon Sep 17 00:00:00 2001 From: Roni Choudhury <2903332+waxlamp@users.noreply.github.com> Date: Mon, 12 Aug 2024 11:28:32 -0400 Subject: [PATCH 5/5] Improve wording Co-authored-by: Kabilar Gunalan --- docs/40_development.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/40_development.md b/docs/40_development.md index 405f8c68..9958918d 100644 --- a/docs/40_development.md +++ b/docs/40_development.md @@ -136,8 +136,8 @@ facilities: help@dandiarchive.org. These are "virtual" email addresses managed by DNS entries. - **Transactional email.** The Archive sends email to users to manage the signup - process and to inform about special situations, long running operations, etc. - such as registration reject/approval, Dandiset embargo and unembargo, changes to + process and to inform about special situations such as long running operations, + registration reject/approval, Dandiset embargo and unembargo, changes to ownership, etc. These are sent via Amazon Simple Email Service (SES), programmatically from the Archive code. - **Mass email.** The maintainers of the Archive infrequently send