mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 13:22:48 +00:00
DOCS: standardize on EXAMPLES (a.k.a. Docs-JumboPatch JetLag Edition)
Migrated all examples: in DOCUMENTATION=''' string to standalone EXAMPLES=''' string Added deprecation warning to moduledev.rst and remove deprecated example from it Fixed up a few typos and uppercased some acronyms. add consistency to how EXAMPLES are formatted
This commit is contained in:
@@ -158,13 +158,17 @@ options:
|
||||
- Set a passphrase for the SSH key. If no
|
||||
passphrase is provided, the SSH key will default to
|
||||
having no passphrase.
|
||||
examples:
|
||||
- code: 'user: name=johnd comment="John Doe" uid=1040'
|
||||
description: "Add the user 'johnd' with a specific uid and a primary group of 'admin'"
|
||||
- code: "user: name=johnd state=absent remove=yes"
|
||||
description: "Remove the user 'johnd'"
|
||||
- code: 'user: name=jsmith generate_ssh_key=yes ssh_key_bits=2048'
|
||||
description: "Create a 2048-bit SSH key for user jsmith"
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Add the user 'johnd' with a specific uid and a primary group of 'admin'
|
||||
- user: name=johnd comment="John Doe" uid=1040
|
||||
|
||||
# Remove the user 'johnd'
|
||||
- user: name=johnd state=absent remove=yes
|
||||
|
||||
# Create a 2048-bit SSH key for user jsmith
|
||||
- user: name=jsmith generate_ssh_key=yes ssh_key_bits=2048
|
||||
'''
|
||||
|
||||
import os
|
||||
|
||||
Reference in New Issue
Block a user