From b711154722ad6956323463b5992c6a68968a18ab Mon Sep 17 00:00:00 2001 From: Patrick Marchand Date: Thu, 4 Jun 2020 13:23:06 -0400 Subject: [PATCH] Apply fix in last commit to other markdown files So a markdown list should be no indentation followed by two spaces. ' ' * one * two --- CONTRIBUTING.md | 2 +- README.md | 18 +++++++++--------- roles/bgp/README.md | 4 ++-- roles/nagios-nrpe/README.md | 2 +- roles/ospf/README.md | 4 ++-- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 557c3c0..d8caf95 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ Contributions are welcome, as long as they respect our current workflow: 2. The dev branch should never be commited to directly, unless you're updating the CHANGELOG file. -3. Use feature branches for anything else, once they've passed all +3. Use feature branches for anything else, once they've passed all CI test, lints and have been reviewed by other contributors through a pull request, they may be merged into the dev branch. diff --git a/README.md b/README.md index ea3b1e0..0182ec5 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ used by Evolix. Put your public key in the remote root's autorized_keys (/root/.ssh/authorized_keys) -1 - Install ansible's prerequisites +1. Install ansible's prerequisites ``` ansible-playbook prerequisite.yml -CDi hosts -l HOSTNAME ``` -2 - Run it +2. Run it ``` ansible-playbook evolixisation.yml --ask-vault-pass -CDKi hosts -l HOSTNAME @@ -26,19 +26,19 @@ ansible-playbook evolixisation.yml --ask-vault-pass -CDKi hosts -l HOSTNAME Changes can be tested by using [Packer](https://www.packer.io/) and [vmm(4)](https://man.openbsd.org/vmm.4) : - * This process depends on the [Go](https://golang.org/) programming language. +* This process depends on the [Go](https://golang.org/) programming language. ``` # pkg_add go packer ``` - * We use the [packer-builder-vmm](https://github.com/prep/packer-builder-vmm) project to bridge Packer and vmm(4) +* We use the [packer-builder-vmm](https://github.com/prep/packer-builder-vmm) project to bridge Packer and vmm(4) ``` $ go get -u github.com/prep/packer-builder-vmm/cmd/packer-builder-vmm ``` - * Here is an example build file +* Here is an example build file ``` $ vim openbsd.json @@ -101,25 +101,25 @@ $ vim openbsd.json } - * You need your unprivileged user to be able to run vmctl(8) through doas(1) +* You need your unprivileged user to be able to run vmctl(8) through doas(1) ``` # echo "permit nopass myunprivilegeduser as root cmd /usr/sbin/vmctl" >> /etc/doas.conf ``` - * Build the virtual machine +* Build the virtual machine ``` $ packer build openbsd.json ``` - * Start it +* Start it ``` doas vmctl start evobsd -cL -d output-vmm/evobsd.qcow2 ``` - * Enable NAT on your host machine +* Enable NAT on your host machine ``` pass out on em0 inet from tap0:network to any nat-to (em0) diff --git a/roles/bgp/README.md b/roles/bgp/README.md index 827529a..3312e75 100644 --- a/roles/bgp/README.md +++ b/roles/bgp/README.md @@ -10,5 +10,5 @@ Everything is in the `tasks/main.yml` file. The full list of variables (with default values) can be found in `defaults/main.yml`. - * `bgp_mailto` : email address the output of the script will be sent to when a change is detected - * `bgp_exclude_grep_command` : facultative grep -v command for some peers not to be checked +* `bgp_mailto` : email address the output of the script will be sent to when a change is detected +* `bgp_exclude_grep_command` : facultative grep -v command for some peers not to be checked diff --git a/roles/nagios-nrpe/README.md b/roles/nagios-nrpe/README.md index 0870336..840698d 100644 --- a/roles/nagios-nrpe/README.md +++ b/roles/nagios-nrpe/README.md @@ -8,6 +8,6 @@ Everything is in the `tasks/main.yml` file. ## Available variables - * `nagios_nrpe_allowed_hosts` : list of IP/hosts authorized (default: none). +* `nagios_nrpe_allowed_hosts` : list of IP/hosts authorized (default: none). The full list of variables (with default values) can be found in `defaults/main.yml`. diff --git a/roles/ospf/README.md b/roles/ospf/README.md index 2cec045..3ebe574 100644 --- a/roles/ospf/README.md +++ b/roles/ospf/README.md @@ -10,5 +10,5 @@ Everything is in the `tasks/main.yml` file. The full list of variables (with default values) can be found in `defaults/main.yml`. - * `ospf_mailto` : email address the output of the scripts will be sent to when a change is detected - * `ospf_sed_command` : facultative sed command to modify the ospfctl output and add a name to IPs +* `ospf_mailto` : email address the output of the scripts will be sent to when a change is detected +* `ospf_sed_command` : facultative sed command to modify the ospfctl output and add a name to IPs