Project

General

Profile

Actions

Bug #21416

closed

Document mail-releated configuration options

Added by Peter Amstutz 3 months ago. Updated 29 days ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Story points:
-
Release relationship:
Auto

Description

User asked about "SendUserSetupNotificationEmail" which does not have any comment in the configuration file explaining exactly what it does. I noticed there are a number of other email-related configuration options that also are not documented. We should fill that in.


Subtasks 1 (0 open1 closed)

Task #21512: Review 21416-email-options-doc ResolvedPeter Amstutz02/21/2024Actions

Related issues

Related to Arvados - Feature #15397: Declutter the APIIn ProgressTom CleggActions
Actions #1

Updated by Peter Amstutz 3 months ago

  • Description updated (diff)
Actions #2

Updated by Peter Amstutz 3 months ago

  • Assigned To set to Peter Amstutz
Actions #3

Updated by Peter Amstutz 2 months ago

Actions #4

Updated by Peter Amstutz 2 months ago

21416-email-options-doc @ dc333e620d19bde703fddaf39cc8b5a78f0f4f4a

developer-run-tests: #4049

  • All agreed upon points are implemented / addressed.
    • added & expanded comments to the config defaults file
  • Anything not implemented (discovered or discussed during work) has a follow-up story.
    • I discovered several keys that are not used. I added them to the list of "decluttering" tasks in the description of #15397
  • Code is tested and passing, both automated and manual, what manual testing was done is described
    • this is documentation only, so it would be weird to fail tests
  • Documentation has been updated.
    • yes
  • Behaves appropriately at the intended scale (describe intended scale).
    • n/a
  • Considered backwards and forwards compatibility issues between client and server.
    • n/a
  • Follows our coding standards and GUI style guidelines.
    • yes
Actions #5

Updated by Peter Amstutz 2 months ago

  • Status changed from New to In Progress
Actions #6

Updated by Lucas Di Pentima 2 months ago

Just one observation:

At line 376: It says "Recipients", if more than one address are allowed, I think we should clarify how multiple addresses should be written (comma separated, or in another way?)

The rest LGTM, thanks!

Actions #7

Updated by Peter Amstutz 2 months ago

  • Status changed from In Progress to Resolved
Actions #8

Updated by Peter Amstutz 29 days ago

  • Release set to 69
Actions

Also available in: Atom PDF