From 2089f7a6219dff25d8c4168896049b21abe05228 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Oskar=20Sch=C3=B6ldstr=C3=B6m?= <m@oxy.fi>
Date: Sat, 29 Dec 2018 10:02:51 -0300
Subject: [PATCH] add docs on debug mode

---
 docs/other/debug.md | 17 +++++++++++++++++
 mkdocs.yml          |  1 +
 2 files changed, 18 insertions(+)
 create mode 100644 docs/other/debug.md

diff --git a/docs/other/debug.md b/docs/other/debug.md
new file mode 100644
index 000000000..13bed9372
--- /dev/null
+++ b/docs/other/debug.md
@@ -0,0 +1,17 @@
+To debug the provisioning step Drupal VM can run the `ansible-playbook` command in verbose mode if you set the `DRUPALVM_DEBUG` environment variable.
+
+```sh
+# verbose mode: ansible-playbook -v
+DRUPALVM_DEBUG=1 vagrant provision
+DRUPALVM_DEBUG=v vagrant provision
+
+# for even more messages: ansible-playbook -vvv
+DRUPALVM_DEBUG=vvv vagrant provision
+
+# for debug mode: ansible-playbook -vvvv
+DRUPALVM_DEBUG=vvvv vagrant provision
+```
+
+In addition to running in verbose mode this also enables deprecation warnings.
+
+For debugging information related to Vagrant see [documentation](https://www.vagrantup.com/docs/other/debugging.html).
diff --git a/mkdocs.yml b/mkdocs.yml
index 1f2a3da0f..254c179d0 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -63,6 +63,7 @@ pages:
     - 'Passing on CLI arguments to ansible': 'extending/ansible-args.md'
     - 'Pre- and Post-Provision Scripts': 'extending/scripts.md'
   - Other Information:
+    - 'Debug mode': 'other/debug.md'
     - 'Networking Notes': 'other/networking.md'
     - 'Vagrant LXC provider': 'other/vagrant-lxc.md'
     - 'Improving Performance': 'other/performance.md'