From 3e5c785a7a06eb604e34c6216cc692eb8c894594 Mon Sep 17 00:00:00 2001
From: Matt White <16320656+matt-FFFFFF@users.noreply.github.com>
Date: Mon, 15 Jul 2024 11:00:48 +0100
Subject: [PATCH] docs: add gitignore notice (#127)

---
 docs/index.md           | 2 ++
 templates/index.md.tmpl | 2 ++
 2 files changed, 4 insertions(+)

diff --git a/docs/index.md b/docs/index.md
index cca414d..c6db3ef 100644
--- 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
index 1b26348..ac8e6a8 100644
--- 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" }}