Fix YAML syntax, adjust more code block languages (#2408)

* Fix broken YAML, or adjust code block type.

* Normalize code block type.

(cherry picked from commit d8c36a0)

Author: felixfontein

docs/docsite/rst/collections_guide/collections_using_playbooks.rst

@@ -34,7 +34,7 @@ This works for roles or any type of plugin distributed within the collection:
 
          - name: Call a debug task
            ansible.builtin.debug:
-             msg: '{{ lookup("my_namespace.my_collection.lookup1", 'param1')| my_namespace.my_collection.filter1 }}'
+             msg: '{{ lookup("my_namespace.my_collection.lookup1", "param1") | my_namespace.my_collection.filter1 }}'
 
 Simplifying module names with the ``collections`` keyword
 ---------------------------------------------------------

docs/docsite/rst/dev_guide/developing_collections_creating.rst

@@ -90,12 +90,12 @@ A collection skeleton is a directory that looks like a collection directory but
 
 An example ``galaxy.yml.j2`` file that accepts an optional dictionary variable ``dependencies`` could look like this:
 
-.. code-block:: yaml+jinja
+.. code-block:: jinja
 
    namespace: {{ namespace }}
    name: {{ collection_name }}
-   version: "{{ (version|quote) is version("0.0.0", operator="gt", version_type="semver")|ternary(version, undef("version must be a valid semantic version greater than 0.0.0")) }}"
-   dependencies: {{ dependencies|default({}, true) }}
+   version: {{ (version|quote) is version('0.0.0', operator='gt', version_type='semver')|ternary(version, undef('version must be a valid semantic version greater than 0.0.0')) }}
+   dependencies: {{ dependencies | default({}, true) }}
 
 To initialize a collection using the new template, pass the path to the skeleton with ``ansible-galaxy collection init``:
 

docs/docsite/rst/dev_guide/migrating_roles.rst

@@ -71,7 +71,7 @@ You will need to use the Fully Qualified Collection Name (FQCN) to use the roles
 
 So for example, in the above collection, the FQCN to access  ``role1`` would be:
 
-.. code-block:: Python
+.. code-block:: python
 
 	mynamespace.mycollection.role1
 

docs/docsite/rst/dev_guide/style_guide/index.rst

@@ -387,7 +387,7 @@ Ensure all icons, images, diagrams, and non text elements have a meaningful alte
 
 To add alt text in rst:
 
-  .. code-block:: reStructuredText
+  .. code-block:: rst
 
     .. image:: path/networkdiag.png
        :width: 400
@@ -416,7 +416,7 @@ Label tables with a descriptive title.
 
 For RST:
 
-  .. code-block:: reStructuredText
+  .. code-block:: rst
 
     .. table:: File descriptions
 

docs/docsite/rst/inventory/implicit_localhost.rst

@@ -19,7 +19,7 @@ In a case like this (or ``local_action``) when Ansible needs to contact a 'local
 
 .. code-block:: yaml
 
-   ...
+   # ...
 
    hosts:
      localhost:

docs/docsite/rst/inventory_guide/connection_details.rst

@@ -27,7 +27,8 @@ By default, Ansible connects to all remote devices with the username you are usi
 
      tasks:
      - name: thing to do first in this playbook
-     . . .
+
+     # ...
 
 as a host variable in inventory:
 

docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst

@@ -139,7 +139,7 @@ For example, the resource model builder includes the ``myos_interfaces.yml`` sam
     short_description: 'Manages <xxxx> attributes of <network_os> <resource>'
     description: 'Manages <xxxx> attributes of <network_os> <resource>.'
     author: Ansible Network Engineer
-   notes:
+    notes:
       - 'Tested against <network_os> <version>'
     options:
       config:
@@ -361,7 +361,7 @@ This example shows how to use the generated collection in a playbook:
 
  .. code-block:: yaml
 
-     ----
+     ---
      - hosts: myos101
        gather_facts: False
        tasks:
@@ -616,7 +616,7 @@ The following example walks through the integration tests for the ``vyos.vyos.vy
         that:
           - "{{ overridden['after'] | symmetric_difference(result['before'])
             | length == 0 }}"
-  always:
+    always:
     - import_tasks: _remove_config.yaml
 
 

docs/docsite/rst/network/getting_started/first_inventory.rst

@@ -361,7 +361,7 @@ and type in the vault password for ``my_user``.
 
 The :option:`--vault-id <ansible-playbook --vault-id>` flag allows different vault passwords for different users or different levels of access. The output includes the username ``my_user`` from your ``ansible-vault`` command and uses the YAML syntax ``key: value``:
 
-.. code-block:: yaml
+.. code-block:: text
 
    ansible_password: !vault |
           $ANSIBLE_VAULT;1.2;AES256;my_user
@@ -376,7 +376,7 @@ This is an example using an extract from a  YAML inventory, as the INI format do
 
 .. code-block:: yaml
 
-  ...
+  # ...
 
   vyos: # this is a group in yaml inventory, but you can also do under a host
     vars:
@@ -391,7 +391,7 @@ This is an example using an extract from a  YAML inventory, as the INI format do
            3837646266663835640a313164343535316666653031353763613037656362613535633538386539
            65656439626166666363323435613131643066353762333232326232323565376635
 
-   ...
+   # ...
 
 To use an inline vaulted variables with an INI inventory you need to store it in a 'vars' file in YAML format,
 it can reside in host_vars/ or group_vars/ to be automatically picked up or referenced from a play through ``vars_files`` or ``include_vars``.

docs/docsite/rst/network/user_guide/cli_parsing.rst

@@ -177,7 +177,7 @@ Lastly in this task, the ``set_fact`` option sets the following ``interfaces`` f
    Ethernet1/10:
        hardware: 100/1000/10000 Ethernet
        mac_address: 5254.005a.f8c6
-   <...>
+   # ...
 
 
 Linux example
@@ -278,7 +278,7 @@ Lastly in this task, the ``set_fact`` option sets the following ``interfaces`` f
      name: enp64s0u1
      state: up
      up: true
-   <...>
+   # ...
 
 
 Parsing JSON
@@ -429,7 +429,7 @@ This task sets the following fact as the ``interfaces`` fact for the host:
          ip: 192.168.101.14
          prefix_length: '24'
      link_state: up
-     <...>
+     # ...
 
 
 Parsing with textfsm
@@ -616,11 +616,11 @@ This example task runs the ``show interface`` command and parses the output as X
 .. code-block:: yaml
 
    - name: "Run command and parse as xml"
-       ansible.utils.cli_parse:
-         command: show interface | xml
-         parser:
-           name: ansible.utils.xml
-     set_fact: interfaces
+     ansible.utils.cli_parse:
+       command: show interface | xml
+       parser:
+         name: ansible.utils.xml
+     register: interfaces
 
 .. note::
 

docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst

@@ -56,7 +56,7 @@ Before running ``ansible-playbook``, run the following commands to enable loggin
 
 After Ansible has finished running you can inspect the log file which has been created on the Ansible control node:
 
-.. code::
+.. code:: console
 
   less $ANSIBLE_LOG_PATH