link fixes, toc and heading updates for specs (#1808)

Azure · Jan 23, 2025 · 79714e5 · 79714e5
1 parent 069fb4e
commit 79714e5
Show file tree

Hide file tree

Showing 127 changed files with 255 additions and 275 deletions.
diff --git a/.github/linters/mlc_config.json b/.github/linters/mlc_config.json
@@ -36,7 +36,7 @@
       }
     }
   ],
-  "timeout": "10s",
+  "timeout": "20s",
   "retryOn429": true,
   "retryCount": 5,
   "fallbackRetryDelay": "30s",

diff --git a/.github/workflows/code-review.yml b/.github/workflows/code-review.yml
@@ -45,8 +45,20 @@
             fetch-depth: 0
 
         - name: Check links in markdown files
-          uses: gaurav-nelson/[email protected].15
+          uses: gaurav-nelson/[email protected].16
           with:
             config-file: ".github/linters/mlc_config.json"
             use-verbose-mode: "yes"
             use-quiet-mode: "yes"
+
+    # check-links:
+    #   name: runner / linkspector
+    #   runs-on: ubuntu-latest
+    #   steps:
+    #     - uses: actions/checkout@v4
+    #     - name: Run linkspector
+    #       uses: umbrelladocs/action-linkspector@v1
+    #       with:
+    #         github_token: ${{ secrets.github_token }}
+    #         reporter: github-pr-review
+    #         fail_level: any
diff --git a/docs/content/indexes/bicep/_index.md b/docs/content/indexes/bicep/_index.md
@@ -23,8 +23,6 @@ For more details on "**What are the different ways to contribute to AVM?**", see
 
 {{% /notice %}}
 
----
-
 ## Status Badges
 
 This section gives you an overview of the latest workflow status of each AVM module in the [Public Bicep Registry repository](https://github.com/Azure/bicep-registry-modules).

diff --git a/docs/content/indexes/bicep/bicep-pattern-modules.md b/docs/content/indexes/bicep/bicep-pattern-modules.md
@@ -5,6 +5,14 @@ linktitle: Pattern Modules
 weight: 2
 ---
 
+
+
+## Module catalog
+
+{{% moduleStats language="Bicep" moduleType="Pattern" showLanguage=true showClassification=true %}}
+
+{{% expand title="➕ Additional information" %}}
+
 {{% notice style="info" %}}
 
 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.
@@ -15,28 +23,14 @@ This page contains various views of the module index (catalog) for **Bicep Patte
 
 {{% /notice %}}
 
-## Module catalog
-
 {{% notice style="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 proposed modules, see the [Proposed modules]({{% siteparam base %}}/indexes/bicep/bicep-pattern-modules/#proposed-modules---) section below.
 
 {{% /notice %}}
 
-The following table shows the number of all available, orphaned and proposed **Bicep Pattern Modules**.
-
-{{% moduleStats language="Bicep" moduleType="Pattern" showLanguage=true showClassification=true %}}
-
-### Module Publication History - 📅
-
-{{% expand title="➕ Module Publication History - Module names, status and owners" expanded="false" %}}
-
-{{% moduleHistory header=true csv="/static/module-indexes/BicepPatternModules.csv" language="Bicep" moduleType="pattern" exclude="Proposed :new:" monthsToShow=9999 %}}
-
 {{% /expand %}}
 
----
-
 ### Published modules - 🟢 & 👀
 
 {{% expand title="➕ Published Modules - Module names, status and owners" expanded="true" %}}
@@ -45,8 +39,6 @@ The following table shows the number of all available, orphaned and proposed **B
 
 {{% /expand %}}
 
----
-
 ### Proposed modules - 🆕
 
 {{% expand title="➕ Proposed Modules - Module names, status and owners" expanded="false" %}}
@@ -55,8 +47,6 @@ The following table shows the number of all available, orphaned and proposed **B
 
 {{% /expand %}}
 
----
-
 ### All modules - 📇
 
 {{% expand title="➕ All Modules - Module names, status and owners" expanded="false" %}}
@@ -65,7 +55,13 @@ The following table shows the number of all available, orphaned and proposed **B
 
 {{% /expand %}}
 
----
+### Module Publication History - 📅
+
+{{% expand title="➕ Module Publication History - Module names, status and owners" expanded="false" %}}
+
+{{% moduleHistory header=true csv="/static/module-indexes/BicepPatternModules.csv" language="Bicep" moduleType="pattern" exclude="Proposed :new:" monthsToShow=9999 %}}
+
+{{% /expand %}}
 
 ## For Module Owners & Contributors
 

diff --git a/docs/content/indexes/bicep/bicep-resource-modules.md b/docs/content/indexes/bicep/bicep-resource-modules.md
@@ -5,6 +5,12 @@ linktitle: Resource Modules
 weight: 1
 ---
 
+## Module catalog
+
+{{% moduleStats language="Bicep" moduleType="Resource" showLanguage=true showClassification=true %}}
+
+{{% expand title="➕ Additional information" %}}
+
 {{% notice style="info" %}}
 
 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.
@@ -15,28 +21,14 @@ This page contains various views of the module index (catalog) for **Bicep Resou
 
 {{% /notice %}}
 
-## Module catalog
-
 {{% notice style="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 proposed modules, see the [Proposed modules]({{% siteparam base %}}/indexes/bicep/bicep-resource-modules/#proposed-modules---) section below.
 
 {{% /notice %}}
 
-The following table shows the number of all available, orphaned and proposed **Bicep Resource Modules**.
-
-{{% moduleStats language="Bicep" moduleType="Resource" showLanguage=true showClassification=true %}}
-
-### Module Publication History - 📅
-
-{{% expand title="➕ Module Publication History - Module names, status and owners" expanded="false" %}}
-
-{{% moduleHistory header=true csv="/static/module-indexes/BicepResourceModules.csv" language="Bicep" moduleType="resource" exclude="Proposed :new:" monthsToShow=9999 %}}
-
 {{% /expand %}}
 
----
-
 ### Published modules - 🟢 & 👀
 
 {{% expand title="➕ Published Modules - Module names, status and owners" expanded="true" %}}
@@ -45,8 +37,6 @@ The following table shows the number of all available, orphaned and proposed **B
 
 {{% /expand %}}
 
----
-
 ### Proposed modules - 🆕
 
 {{% expand title="➕ Proposed Modules - Module names, status and owners" expanded="false" %}}
@@ -55,8 +45,6 @@ The following table shows the number of all available, orphaned and proposed **B
 
 {{% /expand %}}
 
----
-
 ### All modules - 📇
 
 {{% expand title="➕ All Modules - Module names, status and owners" expanded="false" %}}
@@ -65,7 +53,13 @@ The following table shows the number of all available, orphaned and proposed **B
 
 {{% /expand %}}
 
----
+### Module Publication History - 📅
+
+{{% expand title="➕ Module Publication History - Module names, status and owners" expanded="false" %}}
+
+{{% moduleHistory header=true csv="/static/module-indexes/BicepResourceModules.csv" language="Bicep" moduleType="resource" exclude="Proposed :new:" monthsToShow=9999 %}}
+
+{{% /expand %}}
 
 ## For Module Owners & Contributors
 

diff --git a/docs/content/indexes/bicep/bicep-utility-modules.md b/docs/content/indexes/bicep/bicep-utility-modules.md
@@ -5,6 +5,12 @@ linktitle: Utility Modules
 weight: 3
 ---
 
+## Module catalog
+
+{{% moduleStats language="Bicep" moduleType="Utility" showLanguage=true showClassification=true %}}
+
+{{% expand title="➕ Additional information" %}}
+
 {{% notice style="info" %}}
 
 This page contains various views of the module index (catalog) for **Bicep Utility Modules**. To see these views, **click on the expandable sections** with the "➕" sign below.
@@ -15,28 +21,14 @@ This page contains various views of the module index (catalog) for **Bicep Utili
 
 {{% /notice %}}
 
-## Module catalog
-
 {{% notice style="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 proposed modules, see the [Proposed modules]({{% siteparam base %}}/indexes/bicep/bicep-utility-modules/#proposed-modules---) section below.
 
 {{% /notice %}}
 
-The following table shows the number of all available, orphaned and proposed **Bicep Utility Modules**.
-
-{{% moduleStats language="Bicep" moduleType="Utility" showLanguage=true showClassification=true %}}
-
-### Module Publication History - 📅
-
-{{% expand title="➕ Module Publication History - Module names, status and owners" expanded="false" %}}
-
-{{% moduleHistory header=true csv="/static/module-indexes/BicepUtilityModules.csv" language="Bicep" moduleType="utility" exclude="Proposed :new:" monthsToShow=9999 %}}
-
 {{% /expand %}}
 
----
-
 ### Published modules - 🟢 & 👀
 
 {{% expand title="➕ Published Modules - Module names, status and owners" expanded="true" %}}
@@ -45,8 +37,6 @@ The following table shows the number of all available, orphaned and proposed **B
 
 {{% /expand %}}
 
----
-
 ### Proposed modules - 🆕
 
 {{% expand title="➕ Proposed Modules - Module names, status and owners" expanded="false" %}}
@@ -55,8 +45,6 @@ The following table shows the number of all available, orphaned and proposed **B
 
 {{% /expand %}}
 
----
-
 ### All modules - 📇
 
 {{% expand title="➕ All Modules - Module names, status and owners" expanded="false" %}}
@@ -65,7 +53,13 @@ The following table shows the number of all available, orphaned and proposed **B
 
 {{% /expand %}}
 
----
+### Module Publication History - 📅
+
+{{% expand title="➕ Module Publication History - Module names, status and owners" expanded="false" %}}
+
+{{% moduleHistory header=true csv="/static/module-indexes/BicepUtilityModules.csv" language="Bicep" moduleType="utility" exclude="Proposed :new:" monthsToShow=9999 %}}
+
+{{% /expand %}}
 
 ## For Module Owners & Contributors
 

diff --git a/docs/content/indexes/terraform/tf-pattern-modules.md b/docs/content/indexes/terraform/tf-pattern-modules.md
@@ -5,6 +5,12 @@ linktitle: Pattern Modules
 weight: 2
 ---
 
+## Module catalog
+
+{{% moduleStats language="Terraform" moduleType="Pattern" showLanguage=true showClassification=true %}}
+
+{{% expand title="➕ Additional information" %}}
+
 {{% notice style="info" %}}
 
 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.
@@ -15,28 +21,14 @@ This page contains various views of the module index (catalog) for **Terraform P
 
 {{% /notice %}}
 
-## Module catalog
-
 {{% notice style="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 proposed modules, see the [Proposed modules]({{% siteparam base %}}/indexes/terraform/tf-pattern-modules/#proposed-modules---) section below.
 
 {{% /notice %}}
 
-The following table shows the number of all available, orphaned and proposed **Terraform Pattern Modules**.
-
-{{% moduleStats language="Terraform" moduleType="Pattern" showLanguage=true showClassification=true %}}
-
-### Module Publication History - 📅
-
-{{% expand title="➕ Module Publication History - Module names, status and owners" expanded="false" %}}
-
-{{% moduleHistory header=true csv="/static/module-indexes/TerraformPatternModules.csv" language="Terraform" moduleType="pattern" exclude="Proposed :new:" monthsToShow=9999 %}}
-
 {{% /expand %}}
 
----
-
 ### Published modules - 🟢 & 👀
 
 {{% expand title="➕ Published Modules - Module names, status and owners" expanded="true" %}}
@@ -45,8 +37,6 @@ The following table shows the number of all available, orphaned and proposed **T
 
 {{% /expand %}}
 
----
-
 ### Proposed modules - 🆕
 
 {{% expand title="➕ Proposed Modules - Module names, status and owners" expanded="false" %}}
@@ -55,8 +45,6 @@ The following table shows the number of all available, orphaned and proposed **T
 
 {{% /expand %}}
 
----
-
 ### All modules - 📇
 
 {{% expand title="➕ All Modules - Module names, status and owners" expanded="false" %}}
@@ -65,7 +53,13 @@ The following table shows the number of all available, orphaned and proposed **T
 
 {{% /expand %}}
 
----
+### Module Publication History - 📅
+
+{{% expand title="➕ Module Publication History - Module names, status and owners" expanded="false" %}}
+
+{{% moduleHistory header=true csv="/static/module-indexes/TerraformPatternModules.csv" language="Terraform" moduleType="pattern" exclude="Proposed :new:" monthsToShow=9999 %}}
+
+{{% /expand %}}
 
 ## For Module Owners & Contributors
-Original file line number
+Diff line change
@@ Expand Up @@
     {{% /notice %}}
-    ---
     ## Status Badges
     This section gives you an overview of the latest workflow status of each AVM module in the [Public Bicep Registry repository](https://github.com/Azure/bicep-registry-modules).
@@ Expand Down @@