From ecca4cedeaff926f4deb945f171ca168614ff6a1 Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Mon, 18 Oct 2021 14:09:29 +0200 Subject: [PATCH] Misc doc issues (#3572) (#3579) * 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 (cherry picked from commit 3731064368895e54ad2b47c478bf6227868b3d63) Co-authored-by: Vitaly Khabarov --- .../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 92f888c8ab..2a393d483e 100644 --- a/plugins/modules/remote_management/oneview/oneview_datacenter_info.py +++ b/plugins/modules/remote_management/oneview/oneview_datacenter_info.py @@ -46,7 +46,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 @@ -61,7 +63,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 @@ -73,7 +77,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 @@ -87,9 +93,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 3d5da8ab60..90a1ece426 100644 --- a/plugins/modules/remote_management/oneview/oneview_enclosure_info.py +++ b/plugins/modules/remote_management/oneview/oneview_enclosure_info.py @@ -49,7 +49,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 @@ -66,7 +68,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 @@ -79,7 +83,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 @@ -96,13 +102,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 @@ -124,9 +138,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 3c65d5b01e..07163def44 100644 --- a/plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py +++ b/plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py @@ -43,7 +43,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 @@ -57,7 +58,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 @@ -67,7 +69,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 @@ -80,9 +83,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 3df0119b23..13c77a75b3 100644 --- a/plugins/modules/remote_management/oneview/oneview_fc_network_info.py +++ b/plugins/modules/remote_management/oneview/oneview_fc_network_info.py @@ -38,7 +38,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 @@ -51,7 +52,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 @@ -61,7 +64,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 a73386208c..49fd3e1785 100644 --- a/plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py +++ b/plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py @@ -37,7 +37,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 @@ -51,7 +52,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 @@ -61,7 +63,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 0caae963ea..bcb609c4bb 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 @@ -42,7 +42,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 @@ -60,7 +61,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 @@ -74,7 +76,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 351e291baf..065306aba1 100644 --- a/plugins/modules/remote_management/oneview/oneview_network_set_info.py +++ b/plugins/modules/remote_management/oneview/oneview_network_set_info.py @@ -50,10 +50,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 @@ -68,7 +69,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 @@ -83,7 +85,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 @@ -97,7 +100,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 @@ -113,7 +117,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 f0f5fa072a..f818252298 100644 --- a/plugins/modules/remote_management/oneview/oneview_san_manager_info.py +++ b/plugins/modules/remote_management/oneview/oneview_san_manager_info.py @@ -45,7 +45,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 @@ -59,7 +60,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 @@ -69,7 +71,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 2a737ef5a4..ef93cced82 100644 --- a/plugins/modules/source_control/github/github_webhook.py +++ b/plugins/modules/source_control/github/github_webhook.py @@ -96,7 +96,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/