Skip to content
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

Mention that version_added should be collection version in collections #73270

Merged
merged 1 commit into from
Jan 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,8 @@ All fields in the ``DOCUMENTATION`` block are lower-case. All fields are require
:version_added:

* The version of Ansible when the module was added.
* This is a string, and not a float, for example, ``version_added: '2.1'``
* This is a string, and not a float, for example, ``version_added: '2.1'``.
* In collections, this must be the collection version the module was added to, not the Ansible version. For example, ``version_added: 1.0.0``.

:author:

Expand Down Expand Up @@ -182,6 +183,7 @@ All fields in the ``DOCUMENTATION`` block are lower-case. All fields are require

* Only needed if this option was extended after initial Ansible release, in other words, this is greater than the top level `version_added` field.
* This is a string, and not a float, for example, ``version_added: '2.3'``.
* In collections, this must be the collection version the option was added to, not the Ansible version. For example, ``version_added: 1.0.0``.

:suboptions:

Expand Down
6 changes: 3 additions & 3 deletions docs/docsite/rst/dev_guide/developing_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ but with an extra option so you can see how configuration works in Ansible versi
requirements:
- enable in configuration
short_description: Adds time to play stats
version_added: "2.0"
version_added: "2.0" # for collections, use the collection version, not the Ansible version
description:
- This callback just adds total play duration to the play stats.
options:
Expand Down Expand Up @@ -339,7 +339,7 @@ Here's a simple lookup plugin implementation --- this lookup returns the content
DOCUMENTATION = """
lookup: file
author: Daniel Hokka Zakrisson <daniel@hozac.com>
version_added: "0.9"
version_added: "0.9" # for collections, use the collection version, not the Ansible version
short_description: read file contents
description:
- This lookup returns the contents from a file on the Ansible controller's file system.
Expand Down Expand Up @@ -468,7 +468,7 @@ Include the ``vars_plugin_staging`` documentation fragment to allow users to det

DOCUMENTATION = '''
vars: custom_hostvars
version_added: "2.10"
version_added: "2.10" # for collections, use the collection version, not the Ansible version
short_description: Load custom host vars
description: Load custom host vars
options:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ For example, the resource model builder includes the ``myos_interfaces.yml`` sam
description:
- The some_int.
type: int
version_added: '1.1'
version_added: '1.1.0'
some_dict:
type: dict
description:
Expand Down