Initialize Module Indexes ((Catalog) AB#29902 (#51)

Co-authored-by: jeanchg_microsoft <[email protected]>
Co-authored-by: Jack Tracey <[email protected]>

docs/content/indexes/_index.md

@@ -0,0 +1,21 @@
+---
+title: Module Indexes
+geekdocNav: true
+geekdocAlign: left
+geekdocAnchor: true
+---
+
+{{< hint type=tip >}}
+
+**Use the breadcrumb menu** above to navigate back to the main page!
+
+{{< /hint >}}
+
+This section lists all Azure Verified Modules that are available or planned in **Bicep and/or Terraform languages**.
+
+- [Bicep](/Azure-Verified-Modules/indexes/bicep)
+  - [Resource Modules](/Azure-Verified-Modules/indexes/bicep/bicep-resource-modules)
+  - [Pattern Modules](/Azure-Verified-Modules/indexes/bicep/bicep-pattern-modules)
+- [Terraform](/Azure-Verified-Modules/indexes/terraform)
+  - [Resource Modules](/Azure-Verified-Modules/indexes/terraform/tf-resource-modules)
+  - [Pattern Modules](/Azure-Verified-Modules/indexes/terraform/tf-pattern-modules)

docs/content/indexes/bicep/_index.md

@@ -1,12 +1,11 @@
 ---
-title: Bicep AVM Modules Index
+title: Bicep Modules
 geekdocNav: true
 geekdocAlign: left
 geekdocAnchor: true
 ---
 
-{{< hint type=note >}}
+This section lists all Azure Verified Modules that are available in or planned for the **Bicep language**.
 
-*Coming soon*
-
-{{< /hint >}}
+- [Resource Modules](/Azure-Verified-Modules/indexes/bicep/bicep-resource-modules)
+- [Pattern Modules](/Azure-Verified-Modules/indexes/bicep/bicep-pattern-modules)

docs/content/indexes/bicep/bicep-pattern-modules.md

@@ -0,0 +1,42 @@
+---
+title: Bicep Pattern Modules
+geekdocNav: false
+geekdocAlign: left
+geekdocAnchor: true
+---
+
+{{< hint type=warning >}}
+
+**This page is under development.** If you can't see any modules in the tables below, it means that **there are no modules available/planned in this category yet**.
+
+{{< /hint >}}
+
+{{< hint type=tip >}}
+
+**Use the breadcrumb menu** above to navigate back to the main page!
+
+{{< /hint >}}
+
+{{< hint type=note >}}
+
+This page contains various views of the module index (catalog) for **Bicep Pattern Modules**. To see these views, **click on the expandable sections** below.
+
+To see the **full, unfiltered module index**, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/bicep/BicepPatternModules.csv).
+
+{{< /hint >}}
+
+## Module names, status and owners
+{{< expand "Module names, status and owners" "expand/collapse" >}}
+
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/BicepPatternModules.csv" >}}
+
+{{< /expand >}}
+
+<br>
+
+## Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
+{{< expand "Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
+
+{{< moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/BicepPatternModules.csv" >}}
+
+{{< /expand >}}

docs/content/indexes/bicep/bicep-resource-modules.md

@@ -0,0 +1,36 @@
+---
+title: Bicep Resource Modules
+geekdocNav: false
+geekdocAlign: left
+geekdocAnchor: true
+---
+
+{{< hint type=tip >}}
+
+**Use the breadcrumb menu** above to navigate back to the main page!
+
+{{< /hint >}}
+
+{{< hint type=note >}}
+
+This page contains various views of the module index (catalog) for **Bicep Resource Modules**. To see these views, **click on the expandable sections** below.
+
+To see the **full, unfiltered module index**, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/bicep/BicepResourceModules.csv).
+
+{{< /hint >}}
+
+## Module names, status and owners
+{{< expand "Module names, status and owners" "expand/collapse" >}}
+
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/BicepResourceModules.csv" >}}
+
+{{< /expand >}}
+
+<br>
+
+## Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
+{{< expand "Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
+
+{{< moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/BicepResourceModules.csv" >}}
+
+{{< /expand >}}

docs/content/indexes/terraform/_index.md

@@ -1,12 +1,11 @@
 ---
-title: Terraform AVM Modules Index
+title: Terraform Modules
 geekdocNav: true
 geekdocAlign: left
 geekdocAnchor: true
 ---
 
-{{< hint type=note >}}
+This section lists all Azure Verified Modules that are available in or planned for the **Terraform language**.
 
-*Coming soon*
-
-{{< /hint >}}
+- [Resource Modules](/Azure-Verified-Modules/indexes/terraform/tf-resource-modules)
+- [Pattern Modules](/Azure-Verified-Modules/indexes/terraform/tf-pattern-modules)

docs/content/indexes/terraform/tf-pattern-modules.md

@@ -0,0 +1,42 @@
+---
+title: Terraform Pattern Modules
+geekdocNav: false
+geekdocAlign: left
+geekdocAnchor: true
+---
+
+{{< hint type=warning >}}
+
+**This page is under development.** If you can't see any modules in the tables below, it means that **there are no modules available/planned in this category yet**.
+
+{{< /hint >}}
+
+{{< hint type=tip >}}
+
+**Use the breadcrumb menu** above to navigate back to the main page!
+
+{{< /hint >}}
+
+{{< hint type=note >}}
+
+This page contains various views of the module index (catalog) for **Terraform Pattern Modules**. To see these views, **click on the expandable sections** below.
+
+To see the **full, unfiltered module index**, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/terraform/TerraformPatternModules.csv).
+
+{{< /hint >}}
+
+## Module names, status and owners
+{{< expand "Module names, status and owners" "expand/collapse" >}}
+
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/TerraformPatternModules.csv" >}}
+
+{{< /expand >}}
+
+<br>
+
+## Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
+{{< expand "Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
+
+{{< moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/TerraformPatternModules.csv" >}}
+
+{{< /expand >}}

docs/content/indexes/terraform/tf-resource-modules.md

@@ -0,0 +1,42 @@
+---
+title: Terraform Resource Modules
+geekdocNav: false
+geekdocAlign: left
+geekdocAnchor: true
+---
+
+{{< hint type=warning >}}
+
+**This page is under development.** If you can't see any modules in the tables below, it means that **there are no modules available/planned in this category yet**.
+
+{{< /hint >}}
+
+{{< hint type=tip >}}
+
+**Use the breadcrumb menu** above to navigate back to the main page!
+
+{{< /hint >}}
+
+{{< hint type=note >}}
+
+This page contains various views of the module index (catalog) for **Terraform Resource Modules**. To see these views, **click on the expandable sections** below.
+
+To see the **full, unfiltered module index**, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/terraform/TerraformResourceModules.csv).
+
+{{< /hint >}}
+
+## Module names, status and owners
+{{< expand "Module names, status and owners" "expand/collapse" >}}
+
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/TerraformResourceModules.csv" >}}
+
+{{< /expand >}}
+
+<br>
+
+## Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
+{{< expand "Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
+
+{{< moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/TerraformResourceModules.csv" >}}
+
+{{< /expand >}}

docs/content/specs/shared/_index.md

@@ -93,6 +93,11 @@ See the language specific contribution guides for detailed guidance and sample c
 - [Bicep](/Azure-Verified-Modules/contributing/bicep/)
 - [Terraform](/Azure-Verified-Modules/contributing/terraform/)
 
+{{< /hint >}}
+
+{{< hint type=note >}}
+
+We will maintain a set of CSV files in the [AVM Central Repo (`Azure/Azure-Verified-Modules`)](https://github.com/Azure/Azure-Verified-Modules/tree/main/docs/static/module-indexes) with the required TelemetryId prefixes to enable checks to utilize this list to ensure the correct IDs are used. To see the formatted content of these CSV files with additional information, please visit the [AVM Module Indexes](/Azure-Verified-Modules/indexes) page.
 
 {{< /hint >}}
 
@@ -415,7 +420,7 @@ Example: `avm-res-compute-virtualmachine`
 
 {{< hint type=note >}}
 
-We will maintain a JSON file in the [AVM Central Repo (`Azure/Azure-Verified-Modules`)](https://github.com/Azure/Azure-Verified-Modules/issues) with the correct singular names for all resource types to enable checks to utilize this list to ensure repos are named correctly.
+We will maintain a set of CSV files in the [AVM Central Repo (`Azure/Azure-Verified-Modules`)](https://github.com/Azure/Azure-Verified-Modules/tree/main/docs/static/module-indexes) with the correct singular names for all resource types to enable checks to utilize this list to ensure repos are named correctly. To see the formatted content of these CSV files with additional information, please visit the [AVM Module Indexes](/Azure-Verified-Modules/indexes) page.
 
 This will be updated quarterly, or ad-hoc as new RPs/ Resources are created and highlighted via a check failure.
 

docs/data/menu/main.yaml

@@ -6,8 +6,18 @@ main:
     sub:
       - name: 'Bicep'
         ref: 'indexes/bicep'
+        sub:
+          - name: 'Resource Modules'
+            ref: 'indexes/bicep/bicep-resource-modules'
+          - name: 'Pattern Modules'
+            ref: 'indexes/bicep/bicep-pattern-modules'
       - name: 'Terraform'
         ref: 'indexes/terraform'
+        sub:
+          - name: 'Resource Modules'
+            ref: 'indexes/terraform/tf-resource-modules'
+          - name: 'Pattern Modules'
+            ref: 'indexes/terraform/tf-pattern-modules'
   - name: 'Concepts'
     sub:
       - name: 'What, Why, How'

docs/layouts/shortcodes/moduleNameStatusOwners.html

@@ -0,0 +1,27 @@
+{{ $useHeaderRow := .Get "header" }}
+{{ $csv := .Get "csv" }}
+{{ $file := readFile $csv }}
+{{ $rows := $file | transform.Unmarshal (dict "delimiter" ",") }}
+<table>
+  {{ if $useHeaderRow }}
+  {{ $headerRow := index $rows 0 }}
+  {{ $rows = after 1 $rows }}
+  <thead>
+    <tr>
+      <th>Module Name</th>
+      <th>Module Display Name</th>
+      <th>Module Status</th>
+      <th>Primary Module Owner GitHub Handle and Display Name</th>
+    </tr>
+  </thead>
+  {{ end }}
+  {{ range $row, $rows }}
+  <tr>
+    <td>{{ index $row 3 }}</td>
+    {{/* <td><a href="{{ index $row 5 }}">{{ index $row 3 }}</a></td> */}}
+    <td>{{ index $row 2 }}</td>
+    <td>{{ emojify (index $row 4) }}</td>
+    <td>{{ index $row 8 }} {{ if and (ne (index $row 8) "") (ne (index $row 9) "") }} ({{ index $row 9 }}){{ end }}</td>
+  </tr>
+  {{ end }}
+</table>

docs/layouts/shortcodes/moduleNameTelemetryGHTeams.html

@@ -0,0 +1,29 @@
+{{ $useHeaderRow := .Get "header" }}
+{{ $csv := .Get "csv" }}
+{{ $file := readFile $csv }}
+{{ $rows := $file | transform.Unmarshal (dict "delimiter" ",") }}
+<table>
+  {{ if $useHeaderRow }}
+  {{ $headerRow := index $rows 0 }}
+  {{ $rows = after 1 $rows }}
+  <thead>
+    <tr>
+      <th>Module Name</th>
+      <th>Telemetry ID prefix</th>
+      <th>GitHub Teams for Module Owners and Contributors</th>
+    </tr>
+  </thead>
+  {{ end }}
+  {{ range $row, $rows }}
+  <tr>
+    <td>{{ index $row 3 }}</td>
+    <td><code>{{ index $row 7 }}</code></td>
+    <td>
+      <code>{{ index $row 10 }}</code>
+      <br>
+      <code>{{ index $row 11 }}</code>
+    </td>
+    <td></td>
+  </tr>
+  {{ end }}
+</table>

docs/static/module-indexes/BicepPatternModules.csv

@@ -0,0 +1,2 @@
+ProviderNamespace,ResourceType,ModuleDisplayName,ModuleName,ModuleStatus,RepoURL,RegistryURL,TelemetryIdPrefix,PrimaryModuleOwnerGHHandle,PrimaryModuleOwnerDisplayName,ModuleOwnersGHTeam,ModuleContributorsGHTeam,Description
+NoRecordsYet,NoRecordsYet,NoRecordsYet,NoRecordsYet,NoRecordsYet,NoRecordsYet,NoRecordsYet,NoRecordsYet,NoRecordsYet,NoRecordsYet,NoRecordsYet,NoRecordsYet,NoRecordsYet