EOP-164: add support pages for MTA-STS in Momentum #760

juliebin · 2024-05-07T18:52:26Z

Give your PR a recognizable title. For example: "FE-123: Add new prop to component" or "Resolve Issue Create new-pricing-increases-costs #123: Fix bug in component"
Your PR title will be visible in changelogs

What Changed

What changes does this PR propose?
Provide screenshots or screen recordings for any visual changes.

How To Test or Verify

Describe any steps that may help reviewers verify changes.
Anything beyond basic unit testing, such as assistive tech usage, or special interactions.

PR Checklist

Below are some checklists to follow for the correct procedure in different circumstance. The first list ("All PRs Checklist") should be followed for ALL PRs. The next 2 are additive to this list depending on what type of PR you are using.

For example: If you are submitting a content change to one of the support documents, your checklist would include the:

"All PRs Checklist"
AND the "Content Changes Checklist

If you are submitting a feature addition, enhancement, or bug fix, your checklist would include the:

"All PRs Checklist"
AND the "Development Changes Checklist"

All PRs Checklist

Give your pull request a meaningful name.
Use lowercase filenames.
Apply at least one team label according to which team is the content expert (ie. team-FE or team-SAZ)
Pull request approval from the FE team or content experts (see label applied above) that isn't the content creator.

Content Changes Checklist

Check that your article looks correct in the preview here or in a Netlify deploy preview.
Check the links in your article.
Check the images in your article (if there are any)
Check to make sure you are using markdown appropriately as outlined in examples/article.md in the root of the project directory and on the momentum doc's preface article
Check to make sure the Copy and Tone Guidelines are followed.

Development Changes Checklist (some checks are automatic github actions and will not be listed here. ie. "all tests pass")

The appropriate tests are created in cypress/ directory in the root of the project
The lighthouse score is passing according to the FE Support Docs' Service Outline SLI/SLOs

netlify · 2024-05-07T18:52:43Z

✅ Deploy Preview for support-docs ready!

Name	Link
🔨 Latest commit	`c1c29b3`
🔍 Latest deploy log	https://app.netlify.com/sites/support-docs/deploys/66719074e70fbc00084bf471
😎 Deploy Preview	https://deploy-preview-760--support-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

content/momentum/4/config/mta-sts/enable-mta-sts.md

content/momentum/4/mta-sts.md

deepakpn · 2024-05-09T10:40:10Z

content/momentum/4/config/mta-sts/use-mta-sts.md

@@ -0,0 +1,27 @@
+---


On this page, clicking the mta-sts link in the breadcrumb gives me a 404. Can we fix it? Please review breadcrumbs in all new pages.

content/momentum/4/mta-sts.md

kkelley1 · 2024-05-10T16:11:11Z

content/momentum/4/mta-sts.md

+
+### Example 1: Recipient domain enforces MTA-STS and MX is allowed as per the MTA-STS policy
+
+> **MTA-STS policy retrieved from https://mta-sts.domain.com/.well-known/mta-sts.txt**


(nit) These (bogus) links show up as links in the doc. Is there a way to defeat that (e.g. by marking as code?), or do we care?

kkelley1 · 2024-05-10T16:17:29Z

content/momentum/4/mta-sts.md

+- [mta_sts_dns_cname_max_depth](/momentum/4/config/mta-sts/mta-sts-dns-cname-max-depth)
+- [mta_sts_policy_store](/momentum/4/config/mta-sts/mta-sts-policy-store)
+
+## Related [Debug_Flags](/momentum/4/config/ref-debug-flags)


In this page, the default list for ERROR and CRITICAL list most but not all of the types, plus ALL. IMO, it should just say ALL.

I consider it serves not only "default" settings, but an example of listing the logging of interest. A partial list + ALL won't change the final value of the "default".
The page lists some there and followed by

Use ALL instead of listing each service debug flag.

I don't have a strong opinion to change it.

kkelley1 · 2024-05-10T16:35:51Z

content/momentum/4/mta-sts.md

+checks and encryption for delivering email.  RFC 8461 describes the use of MTA-STS for improving
+SMTP security between MTAs.
+
+If the per-domain config option [use_mta_sts](/momentum/4/config/mta-sts/use-mta-sts) is set to `true`,


This seems to ignore the global-level option. Maybe "global or per-domain"?

kkelley1 · 2024-05-10T16:37:45Z

content/momentum/4/config/mta-sts/enable-mta-sts.md

+
+When this option is `true`, the MTA-STS policy mode will be considered along with the configuration
+ values for [TLS](/momentum/4/config/ref-tls) and [TLS_Verify](/momentum/4/config/tls-verify).
+ The more strict policy will apply. E.g. When the MTA-STS policy mode is `enforce`, regardless the


"regardless of the"

kkelley1 · 2024-05-10T16:39:07Z

content/momentum/4/config/mta-sts/enable-mta-sts.md

+When the MTA-STS policy mode is `none`, the policy will be ignored and the configuration values for
+ `TLS` and `TLS_Verify` will be respected.
+
+The default value is `true` when the domain level `use_mta_sts` is `true`.


how about "when use_mta_sts is true for a domain"?

kkelley1 · 2024-05-10T16:41:48Z

content/momentum/4/config/mta-sts/use-mta-sts.md

+<a name="config.use-mta-sts"></a>
+## Name
+
+use_mta_sts — specify whether Momentum should do MTA-STS policy fetching for a domain or not


IMO, the "or not" is implied and not needed

content/momentum/4/config-options-summary.md

seewerah · 2024-05-14T15:33:42Z

content/momentum/4/console-commands/index.md

@@ -44,6 +44,8 @@ description: "This section documents all the non module specific console command
 | [message fail quiet](/momentum/4/console-commands/message-fail-quiet)                       | fail a message and do not create a non-delivery receipt (NDR)                     |
 | [message retry](/momentum/4/console-commands/message-retry)                                 | perform an immediate delivery attempt on a message                                |
 | [module](/momentum/4/console-commands/4-module)                                               | manage loaded modules online                                                      |
+| [mta_sts](/momentum/4/console-commands/mta_sts)                                             | commands to display and manage MTA-STS policy for a domain                        |
+| [\pager](/momentum/4/console-commands/pager)                                                | Page output of long console commands in the console.                              |


Isn't this duplicated?

deepakpn · 2024-05-15T14:45:35Z

content/momentum/4/mta-sts.md

@@ -0,0 +1,100 @@
+---


Kris had raised an issue on slack about the new feature not being searchable. Let's see if the issue gets resolved just by the virtue of merging the PR into main. If not, we'll have to revisit and seek help if needed.

kkelley1 · 2024-06-14T13:21:17Z

content/momentum/4/config/mta-sts/mta-sts-policy-store.md

+
+## Scope
+
+`mta_sts_dns_cname_max_depth` is valid in the global scope.


kkelley1 · 2024-06-14T13:22:05Z

content/momentum/4/console-commands/mta-sts.md

+`mta-sts show domain {domain name}`
+
+`mta-sts refresh policy {domain name}`


typo, should be "mta_sts"

add support pages for MTA-STS in Momentum

158b14d

juliebin added 7 commits May 7, 2024 15:18

update

30f2f6b

update debug_flags for MTA-STS

b34fc8b

minor format

07da5a2

mta_sts ec_console commands

fd65939

more minor changes

43de084

minor update

0b767dc

minor update

68aac62

juliebin requested review from kkelley1, deepakpn and dkoerichbird May 9, 2024 22:04

deepakpn requested changes May 9, 2024

View reviewed changes

kkelley1 reviewed May 10, 2024

View reviewed changes

add mta-sts config options and control commands into summaries

57d115d

deepakpn requested changes May 14, 2024

View reviewed changes

content/momentum/4/config-options-summary.md Outdated Show resolved Hide resolved

review comments

ea735d4

seewerah reviewed May 14, 2024

View reviewed changes

juliebin added 3 commits May 14, 2024 13:04

link to mta-sts config options

25360eb

add new file

d4fcc78

update link

e3f70dd

deepakpn reviewed May 15, 2024

View reviewed changes

kkelley1 reviewed Jun 18, 2024

View reviewed changes

typos

c1c29b3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EOP-164: add support pages for MTA-STS in Momentum #760

EOP-164: add support pages for MTA-STS in Momentum #760

juliebin commented May 7, 2024

netlify bot commented May 7, 2024 •

edited

Loading

deepakpn May 9, 2024

kkelley1 May 10, 2024

kkelley1 May 10, 2024

juliebin May 14, 2024

kkelley1 May 10, 2024

kkelley1 May 10, 2024

kkelley1 May 10, 2024

kkelley1 May 10, 2024

seewerah May 14, 2024

deepakpn May 15, 2024

kkelley1 Jun 14, 2024

kkelley1 Jun 14, 2024


		### Example 1: Recipient domain enforces MTA-STS and MX is allowed as per the MTA-STS policy

		> MTA-STS policy retrieved from https://mta-sts.domain.com/.well-known/mta-sts.txt


		## Scope

		`mta_sts_dns_cname_max_depth` is valid in the global scope.

		`mta-sts show domain {domain name}`

		`mta-sts refresh policy {domain name}`

EOP-164: add support pages for MTA-STS in Momentum #760

Are you sure you want to change the base?

EOP-164: add support pages for MTA-STS in Momentum #760

Conversation

juliebin commented May 7, 2024

What Changed

How To Test or Verify

PR Checklist

All PRs Checklist

Content Changes Checklist

Development Changes Checklist (some checks are automatic github actions and will not be listed here. ie. "all tests pass")

netlify bot commented May 7, 2024 • edited Loading

✅ Deploy Preview for support-docs ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented May 7, 2024 •

edited

Loading