From c5189c4263b2abe47f5e33d2bc5ea33829511725 Mon Sep 17 00:00:00 2001 From: Bill Monkman Date: Wed, 6 Oct 2021 14:29:31 -0700 Subject: [PATCH] fix: Was testing the look of a note in the docs site but forgot to remove it --- doc-site/docs/reference/module-definition.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc-site/docs/reference/module-definition.md b/doc-site/docs/reference/module-definition.md index 6c6fdd47..c95f63a5 100644 --- a/doc-site/docs/reference/module-definition.md +++ b/doc-site/docs/reference/module-definition.md @@ -17,13 +17,11 @@ It also declares the module's dependencies to determine the order of execution i | `icon` | `string` | Path to logo image | | `parameters` | `list(Parameter)` | Parameters to prompt users | | `commands` | `Commands` | Commands to use instead of makefile defaults | -| `zeroVersion` | string([go-semver]) | Zero versions it's compatible with | +| `zeroVersion` | string([go-semver]) | Zero binary versions it's compatible with | ### Commands -:::note Commands are the lifecycle of `zero apply`, it will run all modules' `check` phase, then once satisfied, run in sequence the `apply` phase, then if successful run the `summary` phase. -::: | Parameters | Type | Default | Description | |------------|----------|----------------|--------------------------------------------------------------------------| @@ -42,7 +40,7 @@ Control how module templates will be parsed during the `zero create` command. | `outputDir` | `string` | local directory name for the module, gets commited to version control | ### Condition (module) -Module conditions are considered during the templatint phase (`zero create`), based on parameters supplied from the project definition. +Module conditions are considered during the templating phase (`zero create`), based on parameters supplied from the project definition. Modules can decide to have specific files or directories excluded from the user's project. For example if the user picks `userAuth: no`, we can exclude all the auth resources via templating.