module index filtering, readability & content updates (#158)

Co-authored-by: Jack Tracey <[email protected]>
Azure · Oct 4, 2023 · df3fa94 · df3fa94
1 parent 5fafa5c
commit df3fa94
Show file tree

Hide file tree

Showing 11 changed files with 460 additions and 228 deletions.
diff --git a/.github/linters/mlc_config.json b/.github/linters/mlc_config.json
@@ -14,6 +14,9 @@
     },
     {
       "pattern": "/Azure-Verified-Modules/"
+    },
+    {
+      "pattern": "^https://drone.thegeeklab.de"
     }
   ],
   "httpHeaders": [

diff --git a/docs/content/indexes/bicep/bicep-pattern-modules.md b/docs/content/indexes/bicep/bicep-pattern-modules.md
@@ -5,47 +5,71 @@ geekdocAlign: left
 geekdocAnchor: true
 ---
 
-<!-- {{< hint type=warning >}}
+<!-- {{< hint type=tip >}}
 
-**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**.
+**Use the breadcrumb menu** above to navigate back to the main page!
 
 {{< /hint >}} -->
 
-{{< hint type=tip >}}
+{{< hint type=note >}}
 
-**Use the breadcrumb menu** above to navigate back to the main page!
+This page contains various views of the module index (catalog) for **Bicep Pattern Modules**. To see these views, **click on the expandable sections** with the "➕" sign below.
+
+- {{< icon "gdoc_github" >}} To see the **full, unfiltered, unformatted module index** on GitHub, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/BicepPatternModules.csv).
+
+- {{< icon "gdoc_download" >}} To download the source CSV file, click [here](/Azure-Verified-Modules/module-indexes/BicepPatternModules.csv).
 
 {{< /hint >}}
 
+{{< toc >}}
+
+## Module catalog
+
 {{< hint type=note >}}
+Modules listed below that aren't shown with the status of **`Module Available 🟢`**, are currently in development and are not yet available for use. For planned modules, see the [Planned modules](#planned-modules) section below.
+{{< /hint >}}
 
-This page contains various views of the module index (catalog) for **Bicep Pattern Modules**. To see these views, **click on the expandable sections** with the "➕" sign below.
+### Available modules
 
-- {{< icon "gdoc_github" >}} To see the **full, unfiltered module index** on GitHub, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/BicepPatternModules.csv).
+{{< expand "➕ Available Modules - Module names, status and owners" "expand/collapse" "open" >}}
 
-- {{< icon "gdoc_download" >}} To download the CSV file, click [here](/Azure-Verified-Modules/module-indexes/BicepPatternModules.csv).
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/BicepPatternModules.csv" language="Bicep" moduleType="pattern" exclude="New Module :new:,Migrate From CARML :rocket:" >}}
 
-{{< /hint >}}
+{{< /expand >}}
 
-{{< hint type=important >}}
-Modules listed below that aren't shown with the status of **`Module Available 🟢`**, are currently in development and are not yet available for use.
-{{< /hint >}}
+<br>
+
+### Planned modules
+
+{{< expand "➕ Planned Modules - Module names, status and owners" "expand/collapse" >}}
+
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/BicepPatternModules.csv" language="Bicep" moduleType="pattern" exclude="Module Available :green_circle:,Module Orphaned :eyes:" >}}
+
+{{< /expand >}}
 
 <br>
 
-## Module names, status and owners
+### All modules
 
-{{< expand "➕ Module names, status and owners" "expand/collapse" >}}
+{{< expand "➕ All Modules - Module names, status and owners" "expand/collapse" >}}
 
 {{< moduleNameStatusOwners header=true csv="/static/module-indexes/BicepPatternModules.csv" language="Bicep" moduleType="pattern" >}}
 
 {{< /expand >}}
 
 <br>
 
-## Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
+## For Module Owners & Contributors
+
+### Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
+
+{{< hint type=note >}}
+
+This section is mainly intended **for module owners and contributors** as it contains information important for module development, such as **telemetry ID prefix, and GitHub Teams for Owners & Contributors**.
+
+{{< /hint >}}
 
-{{< expand "➕ Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
+{{< expand "➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
 
 {{< moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/BicepPatternModules.csv" language="Bicep" moduleType="pattern" >}}
 

diff --git a/docs/content/indexes/bicep/bicep-resource-modules.md b/docs/content/indexes/bicep/bicep-resource-modules.md
@@ -5,41 +5,72 @@ geekdocAlign: left
 geekdocAnchor: true
 ---
 
-{{< hint type=tip >}}
+<!-- {{< hint type=tip >}}
 
 **Use the breadcrumb menu** above to navigate back to the main page!
 
-{{< /hint >}}
+{{< /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** with the "➕" sign below.
 
-- {{< icon "gdoc_github" >}} To see the **full, unfiltered module index** on GitHub, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/BicepResourceModules.csv).
+- {{< icon "gdoc_github" >}} To see the **full, unfiltered, unformatted module index** on GitHub, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/BicepResourceModules.csv).
 
-- {{< icon "gdoc_download" >}} To download the CSV file, click [here](/Azure-Verified-Modules/module-indexes/BicepResourceModules.csv).
+- {{< icon "gdoc_download" >}} To download the source CSV file, click [here](/Azure-Verified-Modules/module-indexes/BicepResourceModules.csv).
 
 {{< /hint >}}
 
-{{< hint type=important >}}
-Modules listed below that aren't shown with the status of **`Module Available 🟢`**, are currently in development and are not yet available for use.
+{{< toc >}}
+
+## Module catalog
+
+{{< hint type=note >}}
+Modules listed below that aren't shown with the status of **`Module Available 🟢`**, are currently in development and are not yet available for use. For planned modules, see the [Planned modules](#planned-modules) section below.
 {{< /hint >}}
 
 <br>
 
-## Module names, status and owners
+### Available modules
+
+{{< expand "➕ Available Modules - Module names, status and owners" "expand/collapse" "open" >}}
+
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/BicepResourceModules.csv" language="Bicep" moduleType="resource" exclude="New Module :new:,Migrate From CARML :rocket:" >}}
+
+{{< /expand >}}
+
+<br>
+
+### Planned modules
+
+{{< expand "➕ Planned Modules - Module names, status and owners" "expand/collapse" >}}
 
-{{< expand "➕ Module names, status and owners" "expand/collapse" >}}
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/BicepResourceModules.csv" language="Bicep" moduleType="resource" exclude="Module Available :green_circle:,Module Orphaned :eyes:" >}}
+
+{{< /expand >}}
+
+<br>
+
+### All modules
+
+{{< expand "➕ All Modules - Module names, status and owners" "expand/collapse" >}}
 
 {{< moduleNameStatusOwners header=true csv="/static/module-indexes/BicepResourceModules.csv" language="Bicep" moduleType="resource" >}}
 
 {{< /expand >}}
 
 <br>
 
-## Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
+## For Module Owners & Contributors
+
+{{< hint type=note >}}
+
+This section is mainly intended **for module owners and contributors** as it contains information important for module development, such as **telemetry ID prefix, and GitHub Teams for Owners & Contributors**.
+
+{{< /hint >}}
+### Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
 
-{{< expand "➕ Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
+{{< expand "➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
 
 {{< moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/BicepResourceModules.csv" language="Bicep" moduleType="resource" >}}
 

diff --git a/docs/content/indexes/terraform/tf-pattern-modules.md b/docs/content/indexes/terraform/tf-pattern-modules.md
@@ -5,47 +5,73 @@ geekdocAlign: left
 geekdocAnchor: true
 ---
 
-<!-- {{< hint type=warning >}}
+<!-- {{< hint type=tip >}}
 
-**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**.
+**Use the breadcrumb menu** above to navigate back to the main page!
 
 {{< /hint >}} -->
 
-{{< hint type=tip >}}
+{{< hint type=note >}}
 
-**Use the breadcrumb menu** above to navigate back to the main page!
+This page contains various views of the module index (catalog) for **Terraform Pattern Modules**. To see these views, **click on the expandable sections** with the "➕" sign below.
+
+- {{< icon "gdoc_github" >}} To see the **full, unfiltered, unformatted module index** on GitHub, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/TerraformPatternModules.csv).
+
+- {{< icon "gdoc_download" >}} To download the source CSV file, click [here](/Azure-Verified-Modules/module-indexes/TerraformPatternModules.csv).
 
 {{< /hint >}}
 
+{{< toc >}}
+
+## Module catalog
+
 {{< hint type=note >}}
+Modules listed below that aren't shown with the status of **`Module Available 🟢`**, are currently in development and are not yet available for use. For planned modules, see the [Planned modules](#planned-modules) section below.
+{{< /hint >}}
 
-This page contains various views of the module index (catalog) for **Terraform Pattern Modules**. To see these views, **click on the expandable sections** with the "➕" sign below.
+<br>
 
-- {{< icon "gdoc_github" >}} To see the **full, unfiltered module index** on GitHub, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/TerraformPatternModules.csv).
+### Available modules
 
-- {{< icon "gdoc_download" >}} To download the CSV file, click [here](/Azure-Verified-Modules/module-indexes/TerraformPatternModules.csv).
+{{< expand "➕ Available Modules - Module names, status and owners" "expand/collapse" "open" >}}
 
-{{< /hint >}}
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/TerraformPatternModules.csv" language="Terraform" moduleType="pattern" exclude="New Module :new:,Migrate From TFVM :rocket:" >}}
 
-{{< hint type=important >}}
-Modules listed below that aren't shown with the status of **`Module Available 🟢`**, are currently in development and are not yet available for use.
-{{< /hint >}}
+{{< /expand >}}
 
 <br>
 
-## Module names, status and owners
+### Planned modules
 
-{{< expand "➕ Module names, status and owners" "expand/collapse" >}}
+{{< expand "➕ Planned Modules - Module names, status and owners" "expand/collapse" >}}
+
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/TerraformPatternModules.csv" language="Terraform" moduleType="pattern" exclude="Module Available :green_circle:,Module Orphaned :eyes:" >}}
+
+{{< /expand >}}
+
+<br>
+
+### All modules
+
+{{< expand "➕ All Modules - Module names, status and owners" "expand/collapse" >}}
 
 {{< moduleNameStatusOwners header=true csv="/static/module-indexes/TerraformPatternModules.csv" language="Terraform" moduleType="pattern" >}}
 
 {{< /expand >}}
 
 <br>
 
-## Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
+## For Module Owners & Contributors
+
+{{< hint type=note >}}
+
+This section is mainly intended **for module owners and contributors** as it contains information important for module development, such as **telemetry ID prefix, and GitHub Teams for Owners & Contributors**.
+
+{{< /hint >}}
+
+### Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
 
-{{< expand "➕ Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
+{{< expand "➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
 
 {{< moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/TerraformPatternModules.csv" language="Terraform" moduleType="pattern">}}
 

diff --git a/docs/content/indexes/terraform/tf-resource-modules.md b/docs/content/indexes/terraform/tf-resource-modules.md
@@ -5,41 +5,73 @@ geekdocAlign: left
 geekdocAnchor: true
 ---
 
-{{< hint type=tip >}}
+<!-- {{< hint type=tip >}}
 
 **Use the breadcrumb menu** above to navigate back to the main page!
 
-{{< /hint >}}
+{{< /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** with the "➕" sign below.
 
-- {{< icon "gdoc_github" >}} To see the **full, unfiltered module index** on GitHub, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/TerraformResourceModules.csv).
+- {{< icon "gdoc_github" >}} To see the **full, unfiltered, unformatted module index** on GitHub, click [here](https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/TerraformResourceModules.csv).
 
-- {{< icon "gdoc_download" >}} To download the CSV file, click [here](/Azure-Verified-Modules/module-indexes/TerraformResourceModules.csv).
+- {{< icon "gdoc_download" >}} To download the source CSV file, click [here](/Azure-Verified-Modules/module-indexes/TerraformResourceModules.csv).
 
 {{< /hint >}}
 
-{{< hint type=important >}}
-Modules listed below that aren't shown with the status of **`Module Available 🟢`**, are currently in development and are not yet available for use.
+{{< toc >}}
+
+## Module catalog
+
+{{< hint type=note >}}
+Modules listed below that aren't shown with the status of **`Module Available 🟢`**, are currently in development and are not yet available for use. For planned modules, see the [Planned modules](#planned-modules) section below.
 {{< /hint >}}
 
 <br>
 
-## Module names, status and owners
+### Available modules
+
+{{< expand "➕ Available Modules - Module names, status and owners" "expand/collapse" "open" >}}
+
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/TerraformResourceModules.csv" language="Terraform" moduleType="resource" exclude="New Module :new:,Migrate From TFVM :rocket:" >}}
+
+{{< /expand >}}
+
+<br>
+
+### Planned modules
+
+{{< expand "➕ Planned Modules - Module names, status and owners" "expand/collapse" >}}
+
+{{< moduleNameStatusOwners header=true csv="/static/module-indexes/TerraformResourceModules.csv" language="Terraform" moduleType="resource" exclude="Module Available :green_circle:,Module Orphaned :eyes:" >}}
+
+{{< /expand >}}
+
+<br>
+
+### All modules
 
-{{< expand "➕ Module names, status and owners" "expand/collapse" >}}
+{{< expand "➕ All Modules - Module names, status and owners" "expand/collapse" >}}
 
 {{< moduleNameStatusOwners header=true csv="/static/module-indexes/TerraformResourceModules.csv" language="Terraform" moduleType="resource" >}}
 
 {{< /expand >}}
 
 <br>
 
-## Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
+## For Module Owners & Contributors
+
+{{< hint type=note >}}
+
+This section is mainly intended **for module owners and contributors** as it contains information important for module development, such as **telemetry ID prefix, and GitHub Teams for Owners & Contributors**.
+
+{{< /hint >}}
+
+### Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
 
-{{< expand "➕ Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
+{{< expand "➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" "expand/collapse" >}}
 
 {{< moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/TerraformResourceModules.csv" language="Terraform" moduleType="resource" >}}
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,6 +14,9 @@ @@
         },
         {
           "pattern": "/Azure-Verified-Modules/"
+        },
+        {
+          "pattern": "^https://drone.thegeeklab.de"
         }
       ],
       "httpHeaders": [
@@ Expand Down @@