diff options
author | Felix Fontein <felix@fontein.de> | 2021-02-03 16:20:30 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-02-03 09:20:30 -0600 |
commit | dcec0ec80677616aabb1c002df905f133a40e4f2 (patch) | |
tree | ad7a8899a0ab56a4fa561787c728793c9a221513 /docs | |
parent | d7b562b39395e1b4d7d87de4d710613dd60ac004 (diff) | |
download | ansible-dcec0ec80677616aabb1c002df905f133a40e4f2.tar.gz |
Make sure to mention collection version for version_added as well. (#73270) (#73280)
(cherry picked from commit 73aa571305f52df2a0995b77f51dafdc3787eb96)
Diffstat (limited to 'docs')
3 files changed, 7 insertions, 5 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst index 858e2b31fa..096e9f1781 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -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: @@ -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: diff --git a/docs/docsite/rst/dev_guide/developing_plugins.rst b/docs/docsite/rst/dev_guide/developing_plugins.rst index 4ec085059e..e40a328106 100644 --- a/docs/docsite/rst/dev_guide/developing_plugins.rst +++ b/docs/docsite/rst/dev_guide/developing_plugins.rst @@ -221,7 +221,7 @@ but with an extra option so you can see how configuration works in Ansible versi requirements: - whitelist 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: @@ -334,7 +334,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. @@ -460,7 +460,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: diff --git a/docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst b/docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst index e19067a315..f5715b5f06 100644 --- a/docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst +++ b/docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst @@ -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: |