add example of running apply with -parallelism=1 to docs index (#209)

signalsciences · Jan 4, 2024 · df08657 · df08657
1 parent 3af69ca
commit df08657
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -51,3 +51,17 @@ provider "sigsci" {
 # Resources
 
 For examples of how to use each resource, see [docs/resources](./resources).
+
+## FAQ
+
+FAQ can be found in [docs/guides/FAQ.md](./docs/guides/FAQ.md).
+
+## Errors
+
+Errors occasionally occur when updating certain resources. If an error occurs       please try re-running with `-parallelism=1`:
+
+```
+$ terraform apply -parallelism=1
+```
+
+If running with `-parallelism=1` does not resolve the error, please open an issue.
diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -45,3 +45,17 @@ cd terraform-provider-sigsci && make build
 # Resources
 
 For examples of how to use each resource, see [docs/resources](./resources).
+
+## FAQ
+
+FAQ can be found in [docs/guides/FAQ.md](./docs/guides/FAQ.md).
+
+## Errors
+
+Errors occasionally occur when updating certain resources. If an error occurs       please try re-running with `-parallelism=1`:
+
+```
+$ terraform apply -parallelism=1
+```
+
+If running with `-parallelism=1` does not resolve the error, please open an issue.