Misc doc issues

changelogs/fragments/3572-misc-doc-issues.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+- Add names to tasks in oneview module examples and fix task name in github_webhook module example (https://github.com/ansible-collections/community.general/issues/3353).

plugins/modules/remote_management/oneview/oneview_datacenter_info.py

@@ -47,7 +47,9 @@
     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 @@
       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 @@
     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 @@
       - 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 }}"
 '''
 

plugins/modules/remote_management/oneview/oneview_enclosure_info.py

@@ -50,7 +50,9 @@
   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 @@
   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 @@
   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 @@
   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 @@
   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 }}"
 '''
 

plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py

@@ -44,7 +44,8 @@
   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 @@
   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 @@
   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 @@
   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 }}"
 '''
 

plugins/modules/remote_management/oneview/oneview_fc_network_info.py

@@ -39,7 +39,8 @@
   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 @@
       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 @@
   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 }}"
 '''
 

plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py

@@ -38,7 +38,8 @@
   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 @@
   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 @@
   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 }}"
 '''
 

plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py

@@ -43,7 +43,8 @@
   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 @@
   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 @@
   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 }}"
 '''
 

plugins/modules/remote_management/oneview/oneview_network_set_info.py

@@ -51,10 +51,11 @@
   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 @@
   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 @@
   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 @@
   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 @@
   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 }}"
 '''
 

plugins/modules/remote_management/oneview/oneview_san_manager_info.py

@@ -46,7 +46,8 @@
   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 @@
   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 @@
   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 }}"
 '''
 

plugins/modules/source_control/github/github_webhook.py

@@ -97,7 +97,7 @@
 '''
 
 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/