From ac2e859820be392f425f28129844353e3f3e0ef7 Mon Sep 17 00:00:00 2001 From: David Stephens Date: Mon, 24 Dec 2018 00:30:39 +0000 Subject: [PATCH] Support and Testing docs --- docs/support.md | 8 +++++++- docs/testing.md | 14 ++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/support.md b/docs/support.md index 293e8df0..78ab9f7e 100644 --- a/docs/support.md +++ b/docs/support.md @@ -1,5 +1,11 @@ # Support +Getting support for Ansible-NAS is easy! + ## Gitter.im -## GitHub Issues \ No newline at end of file +Ansible-NAS has its own [Gitter](https://gitter.im/Ansible-NAS/Chat) chat room. `davestephens` hangs out there as well as a few existing users. Come say hi! + +## GitHub Issues + +Raise an [issue](https://github.com/davestephens/ansible-nas/issues), using the supplied template to provide as much information as possible. \ No newline at end of file diff --git a/docs/testing.md b/docs/testing.md index 96e7fd56..2f70f1a6 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -2,8 +2,22 @@ ## Vagrant +A [Vagrant](https://www.vagrantup.com/) Vagrantfile and launch script (`tests/test-vagrant.sh`) are provided to spin up a testing VM. The config in `tests/test.yml` is used by the script to override any existing config in `group_vars/all.yml`. + +By default the VM will be available on 172.30.1.5. If everything has worked correctly after running `tests/test-vagrant.sh`, you should be able to connect to Heimdall on http://172.30.1.5:10080. + +After making changes to the playbook, you can apply them to the running VM by running `vagrant provision`. + +Once you're done testing, destroy the VM with `vagrant destroy`. + ## Travis CI +Travis CI runs some sanity checks against branches. These can be viewed [here](https://github.com/davestephens/ansible-nas/blob/master/.travis.yml). + ### ansible-lint +`ansible-lint` is run as part of the CI (and VSCode tasks are provided) to ensure the playbook confirms to some sort of standard! You may or may not agree with all of the rules, but using it keeps things nice and consistent. + ### Syntax Checking + +`ansible-playbook --syntax-check` is run against nas.yml to ensure nothing is majorly broken. \ No newline at end of file