docs: add deprecateion statement (#39)

Azure · Aug 1, 2024 · c7112ce · c7112ce
1 parent cf6ff8b
commit c7112ce
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/.terraform-docs.yml b/.terraform-docs.yml
@@ -4,7 +4,7 @@
 
 formatter: "markdown document" # this is required
 
-version: "~> 0.17.0"
+version: "~> 0.18"
 
 header-from: "_header.md"
 footer-from: "_footer.md"

diff --git a/README.md b/README.md
@@ -1,6 +1,10 @@
 <!-- BEGIN_TF_DOCS -->
 # Azure Regions and Availability Zones module
 
+> [!WARNING]
+> This module has been ported to Azure Verified Modules and will be archived in the near future.
+> <https://registry.terraform.io/modules/Azure/avm-utl-regions/azurerm>
+
 This module provides an output of all Azure regions and availability zones.
 
 The module outputs a list of objects with the following attributes:

diff --git a/_header.md b/_header.md
@@ -1,5 +1,9 @@
 # Azure Regions and Availability Zones module
 
+> [!WARNING]
+> This module has been ported to Azure Verified Modules and will be archived in the near future.
+> <https://registry.terraform.io/modules/Azure/avm-utl-regions/azurerm>
+
 This module provides an output of all Azure regions and availability zones.
 
 The module outputs a list of objects with the following attributes:

diff --git a/examples/.terraform-docs.yml b/examples/.terraform-docs.yml
@@ -4,7 +4,7 @@
 
 formatter: "markdown document" # this is required
 
-version: "~> 0.17.0"
+version: "~> 0.18"
 
 header-from: "_header.md"
 footer-from: "_footer.md"