Merge pull request #432 from asteris-llc/fix/430-docs

document known bug between conditionals and groups
asteris-llc · Oct 26, 2016 · c2aa856 · c2aa856
2 parents d8c2ee9 + 56cfd78
commit c2aa856
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/content/dependencies.md b/docs/content/dependencies.md
@@ -145,6 +145,13 @@ out!
 
 ## Grouping
 
+{{< note title="Conditionals" >}}
+There is a known bug in converge 0.3.0 that prevents groups from functioning
+inside of conditional statements.  If you try to add a `group` to a statement
+inside of a `case` or `default` you may experience random failures in during
+execution.  A fix for this limitation is planned for 0.4.0
+{{< /note >}}
+
 There can be some scenarios where a group of tasks are not explicitly dependent
 on each other but also cannot be run in parallel. A good example of this is
 package management tools like

diff --git a/docs/content/getting-started.md b/docs/content/getting-started.md
@@ -295,6 +295,7 @@ value is an error.
 - root and module level resources may not reference fields inside of a switch
   statement
 - only the first (top-to-bottom) true branch of a switch will be evaluated
+- `group` statements are not allowed in conditional resources in version 0.3.0
 
 ## What's Next?