From 2187882ee0d30036fd8d3df1e655e625ee13acb4 Mon Sep 17 00:00:00 2001 From: Calin Cristian Andrei Date: Sun, 7 Aug 2022 13:47:51 +0000 Subject: [PATCH] fix contrib/.md errors identified by markdownlint --- .../glusterfs/roles/glusterfs/README.md | 12 +++++++++--- contrib/terraform/aws/README.md | 3 +-- contrib/terraform/exoscale/README.md | 4 +--- contrib/terraform/vsphere/README.md | 4 +--- 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/contrib/network-storage/glusterfs/roles/glusterfs/README.md b/contrib/network-storage/glusterfs/roles/glusterfs/README.md index fd80004c0..dda243df0 100644 --- a/contrib/network-storage/glusterfs/roles/glusterfs/README.md +++ b/contrib/network-storage/glusterfs/roles/glusterfs/README.md @@ -14,12 +14,16 @@ This role performs basic installation and setup of Gluster, but it does not conf Available variables are listed below, along with default values (see `defaults/main.yml`): - glusterfs_default_release: "" +```yaml +glusterfs_default_release: "" +``` You can specify a `default_release` for apt on Debian/Ubuntu by overriding this variable. This is helpful if you need a different package or version for the main GlusterFS packages (e.g. GlusterFS 3.5.x instead of 3.2.x with the `wheezy-backports` default release on Debian Wheezy). - glusterfs_ppa_use: yes - glusterfs_ppa_version: "3.5" +```yaml +glusterfs_ppa_use: yes +glusterfs_ppa_version: "3.5" +``` For Ubuntu, specify whether to use the official Gluster PPA, and which version of the PPA to use. See Gluster's [Getting Started Guide](https://docs.gluster.org/en/latest/Quick-Start-Guide/Quickstart/) for more info. @@ -29,9 +33,11 @@ None. ## Example Playbook +```yaml - hosts: server roles: - geerlingguy.glusterfs +``` For a real-world use example, read through [Simple GlusterFS Setup with Ansible](http://www.jeffgeerling.com/blog/simple-glusterfs-setup-ansible), a blog post by this role's author, which is included in Chapter 8 of [Ansible for DevOps](https://www.ansiblefordevops.com/). diff --git a/contrib/terraform/aws/README.md b/contrib/terraform/aws/README.md index 993d2bb84..7e3428d19 100644 --- a/contrib/terraform/aws/README.md +++ b/contrib/terraform/aws/README.md @@ -36,8 +36,7 @@ terraform apply -var-file=credentials.tfvars ``` - Terraform automatically creates an Ansible Inventory file called `hosts` with the created infrastructure in the directory `inventory` -- Ansible will automatically generate an ssh config file for your bastion hosts. To connect to hosts with ssh using bastion host use generated ssh-bastion.conf. - Ansible automatically detects bastion and changes ssh_args +- Ansible will automatically generate an ssh config file for your bastion hosts. To connect to hosts with ssh using bastion host use generated `ssh-bastion.conf`. Ansible automatically detects bastion and changes `ssh_args` ```commandline ssh -F ./ssh-bastion.conf user@$ip diff --git a/contrib/terraform/exoscale/README.md b/contrib/terraform/exoscale/README.md index 6c4d683ba..be451cce8 100644 --- a/contrib/terraform/exoscale/README.md +++ b/contrib/terraform/exoscale/README.md @@ -31,9 +31,7 @@ The setup looks like following ## Requirements -* Terraform 0.13.0 or newer - -*0.12 also works if you modify the provider block to include version and remove all `versions.tf` files* +* Terraform 0.13.0 or newer (0.12 also works if you modify the provider block to include version and remove all `versions.tf` files) ## Quickstart diff --git a/contrib/terraform/vsphere/README.md b/contrib/terraform/vsphere/README.md index 9148b6e4b..7aa50d899 100644 --- a/contrib/terraform/vsphere/README.md +++ b/contrib/terraform/vsphere/README.md @@ -35,9 +35,7 @@ This setup assumes that the DHCP is disabled in the vSphere cluster and IP addre ## Requirements -* Terraform 0.13.0 or newer - -*0.12 also works if you modify the provider block to include version and remove all `versions.tf` files* +* Terraform 0.13.0 or newer (0.12 also works if you modify the provider block to include version and remove all `versions.tf` files) ## Quickstart