From 37d71898a32c4d977949e0df85fc9212ef663cff Mon Sep 17 00:00:00 2001 From: Brian Cain Date: Wed, 23 Jan 2019 13:23:39 -0800 Subject: [PATCH] More docs updates for new triggers --- website/source/docs/triggers/configuration.html.md | 12 +++++++++++- website/source/docs/triggers/usage.html.md | 8 ++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/website/source/docs/triggers/configuration.html.md b/website/source/docs/triggers/configuration.html.md index c700eedbf..786ac1106 100644 --- a/website/source/docs/triggers/configuration.html.md +++ b/website/source/docs/triggers/configuration.html.md @@ -27,7 +27,7 @@ config.trigger.before :up do |t| end ``` -Triggers can be used with [_actions_](#actions) or [_commands_](#commands) as well, +Triggers can be used with [_actions_](#actions), [_hooks_](#hooks), or [_commands_](#commands), but by default will be defined to run before or after a Vagrant guest. ## Trigger Options @@ -124,6 +124,8 @@ __Note:__ Triggers _without_ the type option will run before or after a Vagrant guest. These most similarly align with the `:action` type, and by default are classified internally as an action. +TODO: ADD INFO ABOUT GUARDING TYPE OPTION WITH VAGRANT VERSION CHECK IN VAGRANTFILE FOR OLDER CLIENTS + ### Commands Command typed triggers can be defined for any valid Vagrant subcommand. They will always @@ -139,6 +141,14 @@ The difference between this and the default behavior is that these triggers are not attached to any specific guest, and will always run before or after the given command. +### Hooks + +
+ Advanced topic! This is an advanced topic for use only if + you want to execute triggers around Vagrant hooks. If you are just getting + started with Vagrant and triggers, you may safely skip this section. +
+ ### Actions
diff --git a/website/source/docs/triggers/usage.html.md b/website/source/docs/triggers/usage.html.md index a5ec536b8..6ec9eecf7 100644 --- a/website/source/docs/triggers/usage.html.md +++ b/website/source/docs/triggers/usage.html.md @@ -131,3 +131,11 @@ Vagrant.configure("2") do |config| end end ``` + +### Typed Triggers + +Show some examples that use: + +* actions +* hooks +* commands