mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-26 14:41:23 -07: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:
parent
39aa5e5eac
commit
5c69918d53
88 changed files with 914 additions and 628 deletions
|
@ -73,13 +73,19 @@ options:
|
|||
- If C(yes), repository will be updated using the supplied
|
||||
remote. Otherwise the repo will be left untouched.
|
||||
Prior to 1.2, this was always 'yes' and could not be disabled.
|
||||
examples:
|
||||
- code: "git: repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout version=release-0.22"
|
||||
description: Example git checkout from Ansible Playbooks
|
||||
- code: "git: repo=ssh://git@github.com/mylogin/hello.git dest=/home/mylogin/hello"
|
||||
description: Example read-write git checkout from github
|
||||
- code: "git: repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout update=no"
|
||||
description: Example just ensuring the repo checkout exists
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Example git checkout from Ansible Playbooks
|
||||
- git: repo=git://foosball.example.org/path/to/repo.git
|
||||
dest=/srv/checkout
|
||||
version=release-0.22
|
||||
|
||||
# Example read-write git checkout from github
|
||||
- git: repo=ssh://git@github.com/mylogin/hello.git dest=/home/mylogin/hello
|
||||
|
||||
# Example just ensuring the repo checkout exists
|
||||
- git: repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout update=no
|
||||
'''
|
||||
|
||||
import re
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue