Skip to content

Commit

Permalink
docs: Fix "beginning with accounts" terminology in the README
Browse files Browse the repository at this point in the history
Prior to this, the very first example of how to use this module used the
wrong terminology and had an incorrect explanation of what the example
was doing.

1) `accounts::user` is a defined type; it's not a class.
2) The users being created are not `Dan` and `Morgan`; they are `dan`
   and `morgan`
3) I tried to clarify that the `accounts::user` define doesn't have to
   be used in a Puppet-managed node's manifest, just that the example
   being shown chose to put it there.
  • Loading branch information
natemccurdy committed Oct 3, 2023
1 parent 219493d commit 90f515f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This module works on many UNIX/Linux operating systems. It does not support conf

### Beginning with accounts

Declare the `accounts` class in a Puppet-managed node's manifest:
Declare the `accounts::user` defined type for each local user you want to manage:

~~~puppet
node default {
Expand All @@ -34,7 +34,7 @@ node default {
}
~~~

The above example creates accounts, home directories, and groups for Dan and Morgan.
The above example creates accounts, home directories, and groups for `dan` and `morgan` in the default node group.

## Usage

Expand Down

0 comments on commit 90f515f

Please sign in to comment.