Bug 1326150

Summary: Documentation of server email configuration needs to be moved
Product: Red Hat Satellite Reporter: Russell Dickenson <rdickens>
Component: Docs User GuideAssignee: Lucie Jirakova <ljirakov>
Status: CLOSED CURRENTRELEASE QA Contact: Stephen Wadeley <swadeley>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.1.0CC: adahms, sbream, swadeley
Target Milestone: Unspecified   
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-10-31 16:37:58 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Comment 1 Andrew Dahms 2016-10-04 11:01:21 UTC
Assigning to Lucie for review.

Lucie - this remains an issue in the 6.2 documentation as well, and it looks like this content would be good as a new section at the end of Chapter 3.

Comment 6 Steve Bream 2016-10-18 13:44:00 UTC
This is a pretty sticky problem - this section seems to cover both configuring specific email notifications to users, which is in the correct place and I don't think causes any problem, and then tangentially and after the fact addresses configuring email in general to allow the sending of the notifications.

I think that the answer might be to leave Procedure 5.4 and the first paragraph after "Testing email delivery" where they are, then to take the subsequent paragraphs and examples and create a section titled something like: "Configuring Satellite Server to send email". I think that this section makes the most sense in the Installation Guide, perhaps in Chapter 5 "Configuring External Services."

The idea being to separate the configuration of Satellite to send email via the /etc/foreman/email.yaml file and the configuration of the user account to specify what emails this user should receive and at what address.

Does that make sense?

So to sum up, I suggest:

Keep section 5.1.4 of the Administration Guide as-is through the first paragraph of "Testing email delivery." End this section with a link to the new section described below, along the lines of "For more information on configuring outgoing Satellite emails, see *new section in the Installation Guide."

Take everything beginning with "The configuration of outgoing emails from the Satellite Server is stored..." and convert the description into a procedure: "Configuring Satellite Server to send email alerts" (or similar) as Section 5.7 in the Installation Guide.