From e877b721f9d511018b5f9a423a2fdd119b54f6b4 Mon Sep 17 00:00:00 2001 From: Patrick Marchand Date: Thu, 4 Jun 2020 11:47:08 -0400 Subject: [PATCH] Fix readme markdown --- CONTRIBUTING.md | 8 ++++---- README.md | 14 +++++++------- roles/bgp/README.md | 6 +++--- roles/nagios-nrpe/README.md | 2 +- roles/ospf/README.md | 6 +++--- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9495015..6a76452 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,17 +2,17 @@ Contributions are welcome, as long as they respect our current workflow: -1. The master branch is only for releases. Once properly tested, + 1. The master branch is only for releases. Once properly tested, the dev branch can be merged, the release tagged and a tar archive created. -2. The dev branch should never be commited to directly, unless + 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. Open issues liberally, but please review closed and opened issues -for duplicates before hand. \ No newline at end of file +for duplicates before hand. diff --git a/README.md b/README.md index 2d65ac2..ea3b1e0 100644 --- a/README.md +++ b/README.md @@ -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 51aad44..827529a 100644 --- a/roles/bgp/README.md +++ b/roles/bgp/README.md @@ -1,5 +1,5 @@ # BGP - + Deployment of BGP check script with its cron, and a best route log cron. ## Tasks @@ -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 3f3f9a9..0870336 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 f0e929c..2cec045 100644 --- a/roles/ospf/README.md +++ b/roles/ospf/README.md @@ -1,5 +1,5 @@ # OSPF - + Deployment of OSPF check scripts with their cron. ## Tasks @@ -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