address linter docs errors

Author: sjpb

ansible/roles/squid/README.md

@@ -4,17 +4,21 @@ Deploy a caching proxy.
 
 **NB:** This role provides two default configurations, selected by setting
 `squid_conf_mode`:
+
 - `default`: This is aimed at providing a proxy for package installs etc.
   for nodes which do not have direct internet connectivity. It assumes access
   to the proxy is protected by the OpenStack security groups applied to the
   cluster. The generated configuration should be reviewed if this is not case.
 - `eessi`: This provides a proxy server for EESSI clients. It uses the
   [recommended configuration](https://www.eessi.io/docs/tutorial/access/proxy/#configuration)
   which assumes a server with:
-      - 10Gbit link or faster to the client systems
-      - a sufficiently powerful CPU
-      - a decent amount of memory for the kernel cache (tens of GBs)
-      - fast local storage - 50GB is used for cache
+
+  - 10Gbit link or faster to the client systems
+  - a sufficiently powerful CPU
+  - a decent amount of memory for the kernel cache (tens of GBs)
+  - fast local storage
+  - 50GB is used for cache
+
   For this use-case the above link recommends at least two squid servers and at
   least one for every (100-500) client nodes.
 
@@ -28,6 +32,7 @@ Deploy a caching proxy.
 ### Role Variables for squid_conf_mode: default
 
 Where noted these map to squid parameters of the same name without the `squid_` prefix - see [squid documentation](https://www.squid-cache.org/Doc/config) for details.
+
 - `squid_started`: Optional bool. Whether to start squid service. Default `true`.
 - `squid_enabled`: Optional bool. Whether squid service is enabled on boot. Default `true`.
 - `squid_cache_mem`: Required str. Size of memory cache, e.g "1024 KB", "12 GB" etc. See squid parameter.

docs/eessi.md

@@ -129,22 +129,24 @@ additional_nodegroups = {
 
 EESSI [recommend](https://www.eessi.io/docs/tutorial/access/proxy/#general-recommendations)
 that:
+
 > The proxy server should have a 10Gbit link to the client systems, a
-sufficiently powerful CPU, a decent amount of memory for the kernel cache (tens
-of GBs), and fast local storage (SSD or NVMe).
+> sufficiently powerful CPU, a decent amount of memory for the kernel cache (tens
+> of GBs), and fast local storage (SSD or NVMe).
 >
 > As a rule of thumb, it is recommended to have (at least) one proxy server for
-every couple of hundred worker nodes (100-500).
+> every couple of hundred worker nodes (100-500).
 
 Generally, both the `squid` nodes and the `eeesi` client nodes can be
 appropriately configured simply by setting the squid mode to `eessi`:
 
-  ```yaml
-  # environments/site/inventory/group_vars/all/squid.yml:
-  squid_conf_mode: eessi
-  ```
+```yaml
+# environments/site/inventory/group_vars/all/squid.yml:
+squid_conf_mode: eessi
+```
 
 In this mode, by default:
+
 - `squid` is configured to allow clients from the access network's CIDR, using
   the EESSI-recommended cache configuration
 - `eessi` is configured to use the `squid` node IPs on the access network (the