Merge pull request #985 from inspec/im/docs

Reorganize reusable text files
inspec · Jan 22, 2024 · 8a9a433 · 8a9a433
2 parents a23887f + 73f89f5
commit 8a9a433
Show file tree

Hide file tree

Showing 486 changed files with 2,174 additions and 1,971 deletions.
diff --git a/docs-chef-io/archetypes/resource.md b/docs-chef-io/archetypes/resource.md
@@ -16,9 +16,9 @@ Use the `{{ .Name }}` Chef InSpec audit resource to test the configuration of...
 
 For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::RESOURCE::NAME` resource]().
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -46,15 +46,15 @@ end
 
 ## Examples
 
-**EXAMPLE DESCRIPTION**
+Example description.
 
 ```ruby
 describe {{ .Name }} do
   #...
 end
 ```
 
-**EXAMPLE DESCRIPTION**
+Example description.
 
 ```ruby
 describe {{ .Name }} do
@@ -64,7 +64,19 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+
+This resource has the following special matchers.
+
+### <MATCHER_NAME>
+
+Matcher description.
+
+```ruby
+describe {{ .Name }} do
+  # matcher example
+end
+```
 
 ## AWS Permissions
 

diff --git a/docs-chef-io/content/inspec/resources/aws_alb.md b/docs-chef-io/content/inspec/resources/aws_alb.md
@@ -14,9 +14,9 @@ Use the `aws_alb` InSpec audit resource to test properties of a single AWS Appli
 
 For additional information, including details on parameters and properties, see the [AWS documentation on Elastic Load Balancing](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference).
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -117,9 +117,9 @@ end
 
 ## Matchers
 
-This InSpec audit resource has no special matchers.
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
-{{% inspec_matchers_link %}}
+This resource has the following special matchers.
 
 ### exist
 
@@ -141,6 +141,6 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}}
+{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}}
 
 You can find detailed documentation at [Authentication and Access Control for Your Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-authentication-access-control.html)
diff --git a/docs-chef-io/content/inspec/resources/aws_albs.md b/docs-chef-io/content/inspec/resources/aws_albs.md
@@ -14,9 +14,9 @@ Use the `aws_albs` InSpec audit resource to test the configuration of a collecti
 
 For additional information, including details on parameters and properties, see the [AWS documentation on Elastic Load Balancing](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference).
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -84,9 +84,9 @@ end
 
 ## Matchers
 
-This InSpec audit resource has no special matchers.
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
-{{% inspec_matchers_link %}}
+This resource has the following special matchers.
 
 ### exist
 
@@ -103,6 +103,6 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}}
+{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}}
 
 You can find detailed documentation at [Authentication and Access Control for Your Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-authentication-access-control.html)
diff --git a/docs-chef-io/content/inspec/resources/aws_ami.md b/docs-chef-io/content/inspec/resources/aws_ami.md
@@ -14,9 +14,9 @@ Use the `aws_ami` InSpec audit resource to test properties of a single AWS AMI.
 
 For additional information, including details on parameters and properties, see the [AWS documentation on EC2 Amazon Machine Images](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html).
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -129,7 +129,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+
+This resource has the following special matchers.
 
 ### be_public
 
@@ -167,6 +169,6 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="EC2:Client:DescribeImages" %}}
+{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeImages" %}}
 
 You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html).
diff --git a/docs-chef-io/content/inspec/resources/aws_amis.md b/docs-chef-io/content/inspec/resources/aws_amis.md
@@ -12,9 +12,9 @@ parent = "inspec/resources/aws"
 
 Use the `aws_amis` InSpec audit resource to test properties of some or all AWS AMIs.
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -190,7 +190,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+
+This resource has the following special matchers.
 
 ### exist
 
@@ -212,6 +214,6 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="EC2:Client:DescribeImages" %}}
+{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeImages" %}}
 
 You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html).
diff --git a/docs-chef-io/content/inspec/resources/aws_amplify_app.md b/docs-chef-io/content/inspec/resources/aws_amplify_app.md
@@ -14,9 +14,9 @@ Use the `aws_amplify_app` InSpec audit resource to test the properties of a sing
 
 For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify  App](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html).
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -98,9 +98,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
-The controls will pass if the `get` method returns at least one result.
+This resource has the following special matchers.
 
 ### exist
 
@@ -132,4 +132,4 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="Amplify:Client:GetAppResult" %}}
+{{% inspec-aws/aws_permissions_principal action="Amplify:Client:GetAppResult" %}}
diff --git a/docs-chef-io/content/inspec/resources/aws_amplify_apps.md b/docs-chef-io/content/inspec/resources/aws_amplify_apps.md
@@ -14,9 +14,9 @@ Use the `aws_amplify_apps` InSpec audit resource to test the properties of Multi
 
 For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify App](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html).
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -125,7 +125,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 The controls will pass if the `List` method returns at least one result.
 
@@ -159,4 +159,4 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="Amplify:Client:ListAppsResult" %}}
+{{% inspec-aws/aws_permissions_principal action="Amplify:Client:ListAppsResult" %}}
diff --git a/docs-chef-io/content/inspec/resources/aws_amplify_branch.md b/docs-chef-io/content/inspec/resources/aws_amplify_branch.md
@@ -14,9 +14,9 @@ Use the `aws_amplify_branch` InSpec audit resource to test the properties of a s
 
 For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify Branch](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html).
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -102,9 +102,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
-The controls will pass if the `get` method returns at least one result.
+This resource has the following special matchers.
 
 ### exist
 
@@ -136,4 +136,4 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="Amplify:Client:GetBranchResult" %}}
+{{% inspec-aws/aws_permissions_principal action="Amplify:Client:GetBranchResult" %}}
diff --git a/docs-chef-io/content/inspec/resources/aws_amplify_branches.md b/docs-chef-io/content/inspec/resources/aws_amplify_branches.md
@@ -14,9 +14,9 @@ Use the `aws_amplify_branches` InSpec audit resource to test the properties of m
 
 For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify branch](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html).
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -126,7 +126,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 The controls will pass if the `list` method returns at least one result.
 
@@ -160,4 +160,4 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="Amplify:Client:ListBranchesResult" %}}
+{{% inspec-aws/aws_permissions_principal action="Amplify:Client:ListBranchesResult" %}}
diff --git a/docs-chef-io/content/inspec/resources/aws_api_gateway_deployment.md b/docs-chef-io/content/inspec/resources/aws_api_gateway_deployment.md
@@ -16,9 +16,9 @@ The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource
 
 For additional information, including details on parameters and properties, see the [AWS ApiGateway Deployment documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html).
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -80,9 +80,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
-The controls will pass if the `get` method returns at least one result.
+This resource has the following special matchers.
 
 ### exist
 
@@ -114,4 +114,4 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="APIGateway:Client:Deployment" %}}
+{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:Deployment" %}}
diff --git a/docs-chef-io/content/inspec/resources/aws_api_gateway_deployments.md b/docs-chef-io/content/inspec/resources/aws_api_gateway_deployments.md
@@ -16,9 +16,9 @@ The AWS::ApiGateway::Deployment resource deploys an API Gateway RestAPI resource
 
 For additional information, including details on parameters and properties, see the [AWS ApiGateway Deployment documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html).
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -60,9 +60,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
-The controls will pass if the `get` method returns at least one result.
+This resource has the following special matchers.
 
 ### exist
 
@@ -94,4 +94,4 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="APIGateway:Client::Deployments" %}}
+{{% inspec-aws/aws_permissions_principal action="APIGateway:Client::Deployments" %}}
diff --git a/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_part.md b/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_part.md
@@ -16,9 +16,9 @@ The `AWS::ApiGateway::DocumentationPart` resource creates a documentation part f
 
 For additional information, including details on parameters and properties, see the [AWS ApiGateway Documentation Part](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html).
 
-## Installation
+## Install
 
-{{% inspec_aws_install %}}
+{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}
 
 ## Syntax
 
@@ -83,9 +83,9 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
-The controls will pass if the `get` method returns at least one result.
+This resource has the following special matchers.
 
 ### exist
 
@@ -117,4 +117,4 @@ end
 
 ## AWS Permissions
 
-{{% aws_permissions_principal action="APIGateway:Client:DocumentationPart" %}}
+{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:DocumentationPart" %}}