-
Couldn't load subscription status.
- Fork 106
Add notice of deprecation of sendmail #4386
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add notice of deprecation of sendmail #4386
Conversation
|
The PR preview for ded7dff is available at theforeman-foreman-documentation-preview-pr-4386.surge.sh The following output files are affected by this PR: |
|
@maximiliankolb Hi Max, I'm not sure how to handle the deprecation information. Do you also want to have it on your side, or should I add conditionals? EDIT: For context, sendmail was deprecated in RHEL 7 already, and is being removed in RHEL 10. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm hesitant to merge this now. The out of the box experience is that you use sendmail and upstream we haven't provided any notice in the 3.16 release notes.
guides/common/modules/proc_configuring-satellite-for-outgoing-emails.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_configuring-satellite-for-outgoing-emails.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_configuring-satellite-for-outgoing-emails.adoc
Outdated
Show resolved
Hide resolved
If the application is not packaged for EL10 anymore, I think it's fair to show the deprecation for all flavors in foreman-documentation. -> Please also include the change for orcharhino. |
Co-authored-by: Ewoud Kohl van Wijngaarden <[email protected]>
This is unrelated. The reason we're dropping it is that often it doesn't work due to modern anti-spam protection. |
Right, but what we want to avoid is pointing from the Satellite deprecation note to a procedure that recommends the deprecated method. I think adding the language about the deprecation without removing content should be fine? If not, I could add conditionals so that the deprecation shows only for downstream docs and not upstream. Though of course I'd rather not, as it adds complexity and increases maintenance for the docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have a deprecation snippet for standardized wording.
Please, use that instead.
|
@ekohl Can we just add it to 3.16 release notes? |
|
@Lennonka I should be more explicit, but that was my thinking yes. If we properly deprecate it in the Foreman 3.16 release noted then this change becomes logical. |
guides/common/modules/proc_configuring-satellite-for-outgoing-emails.adoc
Show resolved
Hide resolved
Co-authored-by: Lena Ansorgová <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you!
Tech ack would be appreciated.
guides/common/modules/proc_configuring-satellite-for-outgoing-emails.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TECH ACK
Co-authored-by: Ewoud Kohl van Wijngaarden <[email protected]> Co-authored-by: Lena Ansorgová <[email protected]>
What changes are you introducing?
Add mentions that sendmail is deprecated.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
Sendmail is deprecated in Satellite 6.18 and will be removed. To prevent users from relying on deprecated features, I want to update the docs so that it's clear which method is future-proof.
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Also some minor style improvements in the procedure.
Contributor checklists
Please cherry-pick my commits into: