Reorganize reusable text files (#722)

* Reorganize reusable text files Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * Update archetype Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * Additional formatting Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> --------- Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
inspec · Jan 22, 2024 · e2b6d93 · e2b6d93
1 parent cbc7823
commit e2b6d93
Show file tree

Hide file tree

Showing 244 changed files with 1,969 additions and 1,186 deletions.
diff --git a/docs-chef-io/archetypes/resource.md b/docs-chef-io/archetypes/resource.md
@@ -16,11 +16,11 @@ Use the `{{ .Name }}` Chef InSpec audit resource to test properties of...
 
 ## Azure REST API Version, Endpoint, and HTTP Client Parameters
 
-{{% inspec_azure_common_parameters %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}}
 
-## Installation
+## Install
 
-{{% inspec_azure_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}}
 
 ## Syntax
 
@@ -48,15 +48,15 @@ end
 
 ## Examples
 
-**EXAMPLE DESCRIPTION**
+EXAMPLE DESCRIPTION
 
 ```ruby
 describe {{ .Name }} do
 
 end
 ```
 
-**EXAMPLE DESCRIPTION**
+EXAMPLE DESCRIPTION
 
 ```ruby
 describe {{ .Name }} do
@@ -66,7 +66,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ## Azure Permissions
 

diff --git a/docs-chef-io/content/inspec/resources/azure_active_directory_domain_service.md b/docs-chef-io/content/inspec/resources/azure_active_directory_domain_service.md
@@ -14,11 +14,11 @@ Use the `azure_active_directory_domain_service` InSpec audit resource to test th
 
 ## Azure REST API Version, Endpoint, and HTTP Client Parameters
 
-{{% inspec_azure_common_parameters %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}}
 
-## Installation
+## Install
 
-{{% inspec_azure_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}}
 
 ## Syntax
 
@@ -95,7 +95,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+
+This resource has the following special matchers.
 
 ### exists
 

diff --git a/docs-chef-io/content/inspec/resources/azure_active_directory_domain_services.md b/docs-chef-io/content/inspec/resources/azure_active_directory_domain_services.md
@@ -14,11 +14,11 @@ Use the `azure_active_directory_domain_services` InSpec audit resource to test t
 
 ## Azure REST API Version, Endpoint, and HTTP Client Parameters
 
-{{% inspec_azure_common_parameters %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}}
 
-## Installation
+## Install
 
-{{% inspec_azure_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}}
 
 ## Syntax
 
@@ -110,7 +110,11 @@ It is advised to use these parameters to narrow down the targeted resources at t
 
 : **Field**: `state`
 
-{{% inspec_filter_table %}}
+{{< note >}}
+
+{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}}
+
+{{< /note>}}
 
 ## Examples
 
@@ -142,7 +146,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+
+This resource has the following special matchers.
 
 ### exists
 

diff --git a/docs-chef-io/content/inspec/resources/azure_active_directory_object.md b/docs-chef-io/content/inspec/resources/azure_active_directory_object.md
@@ -14,11 +14,11 @@ Use the `azure_active_directory_object` InSpec audit resource to test the proper
 
 ## Azure REST API Version, Endpoint, and HTTP Client Parameters
 
-{{% inspec_azure_common_parameters %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}}
 
-## Installation
+## Install
 
-{{% inspec_azure_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}}
 
 ## Syntax
 
@@ -155,7 +155,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+
+This resource has the following special matchers.
 
 ### exists
 

diff --git a/docs-chef-io/content/inspec/resources/azure_active_directory_objects.md b/docs-chef-io/content/inspec/resources/azure_active_directory_objects.md
@@ -14,11 +14,11 @@ Use the `azure_active_directory_objects` InSpec audit resource to test the prope
 
 ## Azure REST API Version, Endpoint, and HTTP Client Parameters
 
-{{% inspec_azure_common_parameters %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}}
 
-## Installation
+## Install
 
-{{% inspec_azure_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}}
 
 ## Syntax
 
@@ -41,7 +41,11 @@ This resource does not require any parameters.
 
 : **Field**: `value`
 
-{{% inspec_filter_table %}}
+{{< note >}}
+
+{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}}
+
+{{< /note>}}
 
 ## Examples
 
@@ -59,7 +63,9 @@ This resource does not require any parameters.
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+
+This resource has the following special matchers.
 
 ### exists
 
@@ -85,4 +91,4 @@ end
 
 ## Azure Permissions
 
-{{% azure_permissions_service_principal role="contributor" %}}
+{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
diff --git a/docs-chef-io/content/inspec/resources/azure_aks_cluster.md b/docs-chef-io/content/inspec/resources/azure_aks_cluster.md
@@ -14,11 +14,11 @@ Use the `azure_aks_cluster` InSpec audit resource to test the properties of an A
 
 ## Azure REST API Version, Endpoint, and HTTP Client Parameters
 
-{{% inspec_azure_common_parameters %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}}
 
-## Installation
+## Install
 
-{{% inspec_azure_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}}
 
 ## Syntax
 
@@ -117,7 +117,7 @@ describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do
 end
 ```
 
-See [integration tests](../../test/integration/verify/controls/azurerm_aks_cluster.rb) for more examples.
+See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_aks_cluster.rb) for more examples.
 
 ## Matchers
 
@@ -145,4 +145,4 @@ end
 
 ## Azure Permissions
 
-{{% azure_permissions_service_principal role="contributor" %}}
+{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
diff --git a/docs-chef-io/content/inspec/resources/azure_aks_clusters.md b/docs-chef-io/content/inspec/resources/azure_aks_clusters.md
@@ -14,11 +14,11 @@ Use the `azure_aks_clusters` InSpec audit resource to test the properties and co
 
 ## Azure REST API Version, Endpoint, and HTTP Client Parameters
 
-{{% inspec_azure_common_parameters %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}}
 
-## Installation
+## Install
 
-{{% inspec_azure_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}}
 
 ## Syntax
 
@@ -71,7 +71,11 @@ end
 
 : **Field**: `properties`
 
-{{% inspec_filter_table %}}
+{{< note >}}
+
+{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}}
+
+{{< /note>}}
 
 ## Examples
 
@@ -85,7 +89,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+
+This resource has the following special matchers.
 
 ### exists
 
@@ -111,4 +117,4 @@ end
 
 ## Azure Permissions
 
-{{% azure_permissions_service_principal role="contributor" %}}
+{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
diff --git a/docs-chef-io/content/inspec/resources/azure_api_management.md b/docs-chef-io/content/inspec/resources/azure_api_management.md
@@ -14,11 +14,11 @@ Use the `azure_api_management` InSpec audit resource to test the properties and
 
 ## Azure REST API Version, Endpoint, and HTTP Client Parameters
 
-{{% inspec_azure_common_parameters %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}}
 
-## Installation
+## Install
 
-{{% inspec_azure_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}}
 
 ## Syntax
 
@@ -88,7 +88,7 @@ azure_api_managements.ids.each do |resource_id|
 end
 ```
 
-See [integration tests](../../test/integration/verify/controls/azurerm_api_management.rb) for more examples.
+See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_api_management.rb) for more examples.
 
 ## Matchers
 
@@ -116,4 +116,4 @@ end
 
 ## Azure Permissions
 
-{{% azure_permissions_service_principal role="contributor" %}}
+{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
diff --git a/docs-chef-io/content/inspec/resources/azure_api_managements.md b/docs-chef-io/content/inspec/resources/azure_api_managements.md
@@ -14,11 +14,11 @@ Use the `azure_api_managements` InSpec audit resource to test the properties and
 
 ## Azure REST API Version, Endpoint, and HTTP Client Parameters
 
-{{% inspec_azure_common_parameters %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}}
 
-## Installation
+## Install
 
-{{% inspec_azure_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}}
 
 ## Syntax
 
@@ -76,7 +76,11 @@ end
 
 : **Field**: `properties`
 
-{{% inspec_filter_table %}}
+{{< note >}}
+
+{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}}
+
+{{< /note>}}
 
 ## Examples
 
@@ -99,7 +103,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+
+This resource has the following special matchers.
 
 ### exists
 
@@ -125,4 +131,4 @@ end
 
 ## Azure Permissions
 
-{{% azure_permissions_service_principal role="contributor" %}}
+{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
diff --git a/docs-chef-io/content/inspec/resources/azure_application_gateway.md b/docs-chef-io/content/inspec/resources/azure_application_gateway.md
@@ -14,11 +14,11 @@ Use the `azure_application_gateway` InSpec audit resource to test the properties
 
 ## Azure REST API Version, Endpoint, and HTTP Client Parameters
 
-{{% inspec_azure_common_parameters %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}}
 
-## Installation
+## Install
 
-{{% inspec_azure_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}}
 
 ## Syntax
 
@@ -84,7 +84,7 @@ describe azure_application_gateway(resource_id: '/subscriptions/{subscriptionId}
 end
 ```
 
-See [integration tests](../../test/integration/verify/controls/azurerm_application_gateway.rb) for more examples.
+See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_application_gateway.rb) for more examples.
 
 ## Matchers
 
@@ -112,4 +112,4 @@ end
 
 ## Azure Permissions
 
-{{% azure_permissions_service_principal role="contributor" %}}
+{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}