From 3731064368895e54ad2b47c478bf6227868b3d63 Mon Sep 17 00:00:00 2001 From: Vitaly Khabarov Date: Mon, 18 Oct 2021 14:53:14 +0300 Subject: [PATCH] Misc doc issues (#3572) * Add names to tasks in oneview module examples * Fix task name in github_webhook module example * Fix trailing whitespace * Add changelog fragment * Remove changelog fragment --- .../oneview/oneview_datacenter_info.py | 20 ++++++++--- .../oneview/oneview_enclosure_info.py | 36 ++++++++++++++----- .../oneview/oneview_ethernet_network_info.py | 16 ++++++--- .../oneview/oneview_fc_network_info.py | 10 ++++-- .../oneview/oneview_fcoe_network_info.py | 9 +++-- ...oneview_logical_interconnect_group_info.py | 9 +++-- .../oneview/oneview_network_set_info.py | 17 +++++---- .../oneview/oneview_san_manager_info.py | 9 +++-- .../source_control/github/github_webhook.py | 2 +- 9 files changed, 90 insertions(+), 38 deletions(-) diff --git a/plugins/modules/remote_management/oneview/oneview_datacenter_info.py b/plugins/modules/remote_management/oneview/oneview_datacenter_info.py index 3e5b96376e..bf3e9a8772 100644 --- a/plugins/modules/remote_management/oneview/oneview_datacenter_info.py +++ b/plugins/modules/remote_management/oneview/oneview_datacenter_info.py @@ -47,7 +47,9 @@ EXAMPLES = ''' api_version: 500 delegate_to: localhost register: result -- ansible.builtin.debug: + +- name: Print fetched information about Data Centers + ansible.builtin.debug: msg: "{{ result.datacenters }}" - name: Gather paginated, filtered and sorted information about Data Centers @@ -62,7 +64,9 @@ EXAMPLES = ''' sort: 'name:descending' filter: 'state=Unmanaged' register: result -- ansible.builtin.debug: + +- name: Print fetched information about paginated, filtered and sorted list of Data Centers + ansible.builtin.debug: msg: "{{ result.datacenters }}" - name: Gather information about a Data Center by name @@ -74,7 +78,9 @@ EXAMPLES = ''' name: "My Data Center" delegate_to: localhost register: result -- ansible.builtin.debug: + +- name: Print fetched information about Data Center found by name + ansible.builtin.debug: msg: "{{ result.datacenters }}" - name: Gather information about the Data Center Visual Content @@ -88,9 +94,13 @@ EXAMPLES = ''' - visualContent delegate_to: localhost register: result -- ansible.builtin.debug: + +- name: Print fetched information about Data Center found by name + ansible.builtin.debug: msg: "{{ result.datacenters }}" -- ansible.builtin.debug: + +- name: Print fetched information about Data Center Visual Content + ansible.builtin.debug: msg: "{{ result.datacenter_visual_content }}" ''' diff --git a/plugins/modules/remote_management/oneview/oneview_enclosure_info.py b/plugins/modules/remote_management/oneview/oneview_enclosure_info.py index 249fea4874..18e245d617 100644 --- a/plugins/modules/remote_management/oneview/oneview_enclosure_info.py +++ b/plugins/modules/remote_management/oneview/oneview_enclosure_info.py @@ -50,7 +50,9 @@ EXAMPLES = ''' no_log: true delegate_to: localhost register: result -- ansible.builtin.debug: + +- name: Print fetched information about Enclosures + ansible.builtin.debug: msg: "{{ result.enclosures }}" - name: Gather paginated, filtered and sorted information about Enclosures @@ -67,7 +69,9 @@ EXAMPLES = ''' no_log: true delegate_to: localhost register: result -- ansible.builtin.debug: + +- name: Print fetched information about paginated, filtered ans sorted list of Enclosures + ansible.builtin.debug: msg: "{{ result.enclosures }}" - name: Gather information about an Enclosure by name @@ -80,7 +84,9 @@ EXAMPLES = ''' no_log: true delegate_to: localhost register: result -- ansible.builtin.debug: + +- name: Print fetched information about Enclosure found by name + ansible.builtin.debug: msg: "{{ result.enclosures }}" - name: Gather information about an Enclosure by name with options @@ -97,13 +103,21 @@ EXAMPLES = ''' no_log: true delegate_to: localhost register: result -- ansible.builtin.debug: + +- name: Print fetched information about Enclosure found by name + ansible.builtin.debug: msg: "{{ result.enclosures }}" -- ansible.builtin.debug: + +- name: Print fetched information about Enclosure Script + ansible.builtin.debug: msg: "{{ result.enclosure_script }}" -- ansible.builtin.debug: + +- name: Print fetched information about Enclosure Environmental Configuration + ansible.builtin.debug: msg: "{{ result.enclosure_environmental_configuration }}" -- ansible.builtin.debug: + +- name: Print fetched information about Enclosure Utilization + ansible.builtin.debug: msg: "{{ result.enclosure_utilization }}" - name: "Gather information about an Enclosure with temperature data at a resolution of one sample per day, between two @@ -125,9 +139,13 @@ EXAMPLES = ''' no_log: true delegate_to: localhost register: result -- ansible.builtin.debug: + +- name: Print fetched information about Enclosure found by name + ansible.builtin.debug: msg: "{{ result.enclosures }}" -- ansible.builtin.debug: + +- name: Print fetched information about Enclosure Utilization + ansible.builtin.debug: msg: "{{ result.enclosure_utilization }}" ''' diff --git a/plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py b/plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py index 1f25364d3a..f1b55165b1 100644 --- a/plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py +++ b/plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py @@ -44,7 +44,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Ethernet Networks + ansible.builtin.debug: msg: "{{ result.ethernet_networks }}" - name: Gather paginated and filtered information about Ethernet Networks @@ -58,7 +59,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about paginated and filtered list of Ethernet Networks + ansible.builtin.debug: msg: "{{ result.ethernet_networks }}" - name: Gather information about an Ethernet Network by name @@ -68,7 +70,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Ethernet Network found by name + ansible.builtin.debug: msg: "{{ result.ethernet_networks }}" - name: Gather information about an Ethernet Network by name with options @@ -81,9 +84,12 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Ethernet Network Associated Profiles + ansible.builtin.debug: msg: "{{ result.enet_associated_profiles }}" -- ansible.builtin.debug: + +- name: Print fetched information about Ethernet Network Associated Uplink Groups + ansible.builtin.debug: msg: "{{ result.enet_associated_uplink_groups }}" ''' diff --git a/plugins/modules/remote_management/oneview/oneview_fc_network_info.py b/plugins/modules/remote_management/oneview/oneview_fc_network_info.py index 4707f39f2d..40fed8d017 100644 --- a/plugins/modules/remote_management/oneview/oneview_fc_network_info.py +++ b/plugins/modules/remote_management/oneview/oneview_fc_network_info.py @@ -39,7 +39,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Fibre Channel Networks + ansible.builtin.debug: msg: "{{ result.fc_networks }}" - name: Gather paginated, filtered and sorted information about Fibre Channel Networks @@ -52,7 +53,9 @@ EXAMPLES = ''' filter: 'fabricType=FabricAttach' delegate_to: localhost register: result -- ansible.builtin.debug: + +- name: Print fetched information about paginated, filtered and sorted list of Fibre Channel Networks + ansible.builtin.debug: msg: "{{ result.fc_networks }}" - name: Gather information about a Fibre Channel Network by name @@ -62,7 +65,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Fibre Channel Network found by name + ansible.builtin.debug: msg: "{{ result.fc_networks }}" ''' diff --git a/plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py b/plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py index 6cb3501ddf..e581bff862 100644 --- a/plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py +++ b/plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py @@ -38,7 +38,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about FCoE Networks + ansible.builtin.debug: msg: "{{ result.fcoe_networks }}" - name: Gather paginated, filtered and sorted information about FCoE Networks @@ -52,7 +53,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about paginated, filtered and sorted list of FCoE Networks + ansible.builtin.debug: msg: "{{ result.fcoe_networks }}" - name: Gather information about a FCoE Network by name @@ -62,7 +64,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about FCoE Network found by name + ansible.builtin.debug: msg: "{{ result.fcoe_networks }}" ''' diff --git a/plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py b/plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py index 7a0f0dc987..436dd5d62b 100644 --- a/plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py +++ b/plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py @@ -43,7 +43,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Logical Interconnect Groups + ansible.builtin.debug: msg: "{{ result.logical_interconnect_groups }}" - name: Gather paginated, filtered and sorted information about Logical Interconnect Groups @@ -61,7 +62,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about paginated, filtered and sorted list of Logical Interconnect Groups + ansible.builtin.debug: msg: "{{ result.logical_interconnect_groups }}" - name: Gather information about a Logical Interconnect Group by name @@ -75,7 +77,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Logical Interconnect Group found by name + ansible.builtin.debug: msg: "{{ result.logical_interconnect_groups }}" ''' diff --git a/plugins/modules/remote_management/oneview/oneview_network_set_info.py b/plugins/modules/remote_management/oneview/oneview_network_set_info.py index 595d003c56..2d610f2b57 100644 --- a/plugins/modules/remote_management/oneview/oneview_network_set_info.py +++ b/plugins/modules/remote_management/oneview/oneview_network_set_info.py @@ -51,10 +51,11 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Network Sets + ansible.builtin.debug: msg: "{{ result.network_sets }}" -- name: Gather paginated, filtered, and sorted information about Network Sets +- name: Gather paginated, filtered and sorted information about Network Sets community.general.oneview_network_set_info: hostname: 172.16.101.48 username: administrator @@ -69,7 +70,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about paginated, filtered and sorted list of Network Sets + ansible.builtin.debug: msg: "{{ result.network_sets }}" - name: Gather information about all Network Sets, excluding Ethernet networks @@ -84,7 +86,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Network Sets, excluding Ethernet networks + ansible.builtin.debug: msg: "{{ result.network_sets }}" - name: Gather information about a Network Set by name @@ -98,7 +101,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Network Set found by name + ansible.builtin.debug: msg: "{{ result.network_sets }}" - name: Gather information about a Network Set by name, excluding Ethernet networks @@ -114,7 +118,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about Network Set found by name, excluding Ethernet networks + ansible.builtin.debug: msg: "{{ result.network_sets }}" ''' diff --git a/plugins/modules/remote_management/oneview/oneview_san_manager_info.py b/plugins/modules/remote_management/oneview/oneview_san_manager_info.py index 46ed001827..284371cafc 100644 --- a/plugins/modules/remote_management/oneview/oneview_san_manager_info.py +++ b/plugins/modules/remote_management/oneview/oneview_san_manager_info.py @@ -46,7 +46,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about SAN Managers + ansible.builtin.debug: msg: "{{ result.san_managers }}" - name: Gather paginated, filtered and sorted information about SAN Managers @@ -60,7 +61,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about paginated, filtered and sorted list of SAN Managers + ansible.builtin.debug: msg: "{{ result.san_managers }}" - name: Gather information about a SAN Manager by provider display name @@ -70,7 +72,8 @@ EXAMPLES = ''' delegate_to: localhost register: result -- ansible.builtin.debug: +- name: Print fetched information about SAN Manager found by provider display name + ansible.builtin.debug: msg: "{{ result.san_managers }}" ''' diff --git a/plugins/modules/source_control/github/github_webhook.py b/plugins/modules/source_control/github/github_webhook.py index 8703863fa9..fcb6f8d06f 100644 --- a/plugins/modules/source_control/github/github_webhook.py +++ b/plugins/modules/source_control/github/github_webhook.py @@ -97,7 +97,7 @@ author: ''' EXAMPLES = ''' -- name: create a new webhook that triggers on push (password auth) +- name: Create a new webhook that triggers on push (password auth) community.general.github_webhook: repository: ansible/ansible url: https://www.example.com/hooks/