docs: add gitignore notice (#127)

Azure · Jul 15, 2024 · 3e5c785 · 3e5c785
1 parent 04b4e66
commit 3e5c785
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -20,6 +20,8 @@ Use the navigation to the left to read about the available resources.
 
 ~> **Warning** This provider is still in development but is ready for initial testing and feedback via [GitHub Issues](https://github.com/Azure/terraform-provider-alz/issues).
 
+~> **Important** Make sure to add `.alzlib` to your `.gitignore` file to avoid committing the downloaded ALZ library to your repository.
+
 ## Example Usage
 
 ```terraform

diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -20,6 +20,8 @@ Use the navigation to the left to read about the available resources.
 
 ~> **Warning** This provider is still in development but is ready for initial testing and feedback via [GitHub Issues](https://github.com/Azure/terraform-provider-alz/issues).
 
+~> **Important** Make sure to add `.alzlib` to your `.gitignore` file to avoid committing the downloaded ALZ library to your repository.
+
 ## Example Usage
 
 {{ tffile "examples/provider/provider.tf" }}