(MODULES-11572) Clarify ensure parameter behavior in user documentation
#506
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tion This updates the user parameter description to clarify the behavior of `ensure => 'absent'`, explicitly stating that the user, their home directory, and any managed SSH keys are fully removed regardless of `purge_home_user` or `purge_sshkeys` settings. Also improves wording consistency and readability.
There was a problem hiding this comment.
Pull Request Overview
This PR clarifies the behavior of ensure => 'absent' in the accounts::user reference, explicitly stating that the user, their home directory, and managed SSH keys are fully removed regardless of related purge settings. It also improves wording consistency and readability.
- Specifies behavior for both
'present'and'absent'cases. - Updates terminology for home directory and SSH keys.
- Notes override of
purge_home_userandpurge_sshkeys.
Comments suppressed due to low confidence (1)
REFERENCE.md:198
- [nitpick] Wrap the values 'present' and 'absent' in inline code formatting (e.g.,
presentandabsent) to maintain consistency with other parameter descriptions and default value styling.
should exist. Valid values are 'present' and 'absent'. When set to 'present',
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This updates the user parameter description to clarify the behavior of
ensure => 'absent', explicitly stating that the user, their home directory, and any managed SSH keys are fully removed regardless ofpurge_home_userorpurge_sshkeyssettings. Also improves wording consistency and readability.Checklist
puppet apply)