Mini Content Journey

Who is your target persona?

Administrator

What stage of the user journey are you targeting?

Expand

Why is this content important?

• One part of this story is in Installation (high-priority guide): 4.9. Configuring Satellite Server for outgoing emails
• We have had several bugs reported against the procedures in the past ~2 years (with customer cases linked or from customer-facing teams). That indicates that they get viewed and makes them a good candidate for a review.

What is the main user goal aka job to be done?

As an administrator, I want to configure email notifications and test their delivery so that my server sends out email notifications on the events that I consider noteworthy.

(This might also include: As a user, I want to receive email notifications from Satellite. In which case we can use the procedure introduction to distinguish what user persona a particular procedure targets.)

What high level steps does the user need to take to accomplish the goal?

Configure Satellite server for email notifications, configure email preferences, test email delivery.

(Optional) What is the general sentiment of users towards this goal?

(Optional) What pain points are the user likely to encounter when accomplishing this goal?

• One procedure in the Installation guide (for admin users), other modules in the Admin guide (for admins and users), they are cross-linked but it's not a convenient user experience.
• Duplication between web UI and docs (list of email notification types).
• Workflow is unclear: It seems there are multiple end goals. Some procedures are prerequisites for others but the connection is unclear at first glance.

(Optional) What other feedback do users have around this goal?

(Optional) Are there any additional opportunities you can also implement for the user when documenting this goal?

• Move the procedure in Install guide to Admin guide.
• Use procedure introductions to clarify which type of user is the procedure intended for as well as the use case.
• Investigate whether we need two verification procedures and if so, clarify what the difference between them is and their respective use cases.
• Investigate whether the testing/verification procedures can be merged with one of the other procedures.
• Investigate whether we can make the reference of notification types shorter.
• Possibly add an example of a useful email notification that can be configured?

Links to existing content 

https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/installing_satellite_server_in_a_connected_network_environment/index#Configuring_Server_for_Outgoing_Emails_satellite

https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/administering_red_hat_satellite/index#Configuring_Email_Notifications_admin

People:

• SME: [SME name]
• QE: [QE name]

Release Note: No

Documentation Outline{}

• Configuring server for outgoing emails (Procedure)
  • Prerequisite: https://issues.redhat.com/browse/SAT-29891

• Configuring email notification preferences for users (Procedure)

• • Includes testing email delivery as a verification step
• Configuring email notification preferences for a host (Procedure)

• Highlighted email notification types (Reference)
  • (not a complete list, just the ones worth highlighting)