Merge pull request #105 from inspec/im/docs

CHEF-4267 reorganize reusable text files
inspec · Jan 22, 2024 · d31877b · d31877b
2 parents 244b6a1 + 6927130
commit d31877b
Show file tree

Hide file tree

Showing 17 changed files with 38 additions and 33 deletions.
diff --git a/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instance.md b/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instance.md
@@ -143,7 +143,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ### exist
 

diff --git a/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instances.md b/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instances.md
@@ -126,7 +126,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ### exist
 
@@ -148,6 +148,6 @@ end
 
 ### Alicloud Permissions
 
-{{% alicloud_principal_action action="rds:DescribeDBInstances" %}}
+{{% inspec-alicloud/alicloud_principal_action action="rds:DescribeDBInstances" %}}
 
 You can find documentation at [Use RAM to manage ApsaraDB for RDS permissions](https://www.alibabacloud.com/help/doc-detail/58932.htm#section-rhd-4ll-5gb).
diff --git a/docs-chef-io/content/inspec/resources/alicloud_disk.md b/docs-chef-io/content/inspec/resources/alicloud_disk.md
@@ -108,7 +108,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ### exist
 
@@ -138,7 +138,7 @@ it { should be_encrypted }
 
 ### Alicloud Permissions
 
-{{% alicloud_principal_action action="ecs:DescribeDisks" %}}
+{{% inspec-alicloud/alicloud_principal_action action="ecs:DescribeDisks" %}}
 
-{{% alibaba_access_management_doc %}}
-{{% alibaba_authentication_ecs_api_doc %}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ecs_api_doc.md" >}}
diff --git a/docs-chef-io/content/inspec/resources/alicloud_disks.md b/docs-chef-io/content/inspec/resources/alicloud_disks.md
@@ -96,7 +96,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ### exist
 
@@ -118,7 +118,7 @@ end
 
 ### Alicloud Permissions
 
-{{% alicloud_principal_action action="ecs:DescribeDisks" %}}
+{{% inspec-alicloud/alicloud_principal_action action="ecs:DescribeDisks" %}}
 
-{{% alibaba_access_management_doc %}}
-{{% alibaba_authentication_ecs_api_doc %}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ecs_api_doc.md" >}}
diff --git a/docs-chef-io/content/inspec/resources/alicloud_ecs_instance.md b/docs-chef-io/content/inspec/resources/alicloud_ecs_instance.md
@@ -159,7 +159,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ### exist
 
@@ -179,5 +179,5 @@ it { should_not exist }
 
 Your Principal will need the `ecs:DescribeInstances`, `ecs:DescribeInstanceAttribute` and `ecs:DescribeInstanceRamRole` actions with Effect set to Allow.
 
-{{% alibaba_access_management_doc %}}
-{{% alibaba_authentication_ecs_api_doc %}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ecs_api_doc.md" >}}
diff --git a/docs-chef-io/content/inspec/resources/alicloud_ecs_instances.md b/docs-chef-io/content/inspec/resources/alicloud_ecs_instances.md
@@ -191,7 +191,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ### exist
 
@@ -215,5 +215,5 @@ end
 
 Your Principal will need the `ecs:DescribeInstances` and `ecs:DescribeInstanceRamRole` actions with Effect set to Allow.
 
-{{% alibaba_access_management_doc %}}
-{{% alibaba_authentication_ecs_api_doc %}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ecs_api_doc.md" >}}
diff --git a/docs-chef-io/content/inspec/resources/alicloud_ims_user.md b/docs-chef-io/content/inspec/resources/alicloud_ims_user.md
@@ -85,7 +85,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ### exist
 
@@ -109,4 +109,4 @@ end
 
 ### Alicloud Permissions
 
-{{% alicloud_principal_action action="ims:GetLoginProfile" %}}
+{{% inspec-alicloud/alicloud_principal_action action="ims:GetLoginProfile" %}}
diff --git a/docs-chef-io/content/inspec/resources/alicloud_ram_policies.md b/docs-chef-io/content/inspec/resources/alicloud_ram_policies.md
@@ -109,5 +109,5 @@ end
 
 Your Principal will need the `ram:ListPolicies` and `ram:ListEntitiesForPolicy` actions with Effect set to Allow.
 
-{{% alibaba_access_management_doc %}}
-{{% alibaba_authentication_ram_api_doc %}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md" >}}
diff --git a/docs-chef-io/content/inspec/resources/alicloud_ram_policy.md b/docs-chef-io/content/inspec/resources/alicloud_ram_policy.md
@@ -158,7 +158,7 @@ its('attachment_count') { should be eq 7 }
 
 This InSpec audit resource has the following special matchers.
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ### exist
 
@@ -297,5 +297,5 @@ it { should have_statement(Resource: /acs:oss.+:(sally|kim)/) }
 
 Your Principal will need the `ram:GetPolicy` and `ram:ListEntitiesForPolicy` actions with Effect set to Allow.
 
-{{% alibaba_access_management_doc %}}
-{{% alibaba_authentication_ram_api_doc %}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md" >}}
diff --git a/docs-chef-io/content/inspec/resources/alicloud_ram_user.md b/docs-chef-io/content/inspec/resources/alicloud_ram_user.md
@@ -106,7 +106,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ### exist
 
@@ -142,5 +142,5 @@ This will check whether the requested user has a login profile for console acces
 
 Your Principal will need the following permissions action with Effect set to Allow: `ram:Getuser`, `ram:GetLoginProfile`, `ram:ListAccessKeys`.
 
-{{% alibaba_access_management_doc %}}
-{{% alibaba_authentication_ram_api_doc %}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md" >}}
diff --git a/docs-chef-io/content/inspec/resources/alicloud_ram_user_mfa.md b/docs-chef-io/content/inspec/resources/alicloud_ram_user_mfa.md
@@ -58,7 +58,7 @@ end
 
 ## Matchers
 
-{{% inspec_matchers_link %}}
+{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
 
 ### exist
 
@@ -76,7 +76,7 @@ it { should_not exist }
 
 ### Alicloud Permissions
 
-{{% alicloud_principal_action action="ram:GetUserMFAInfo" %}}
+{{% inspec-alicloud/alicloud_principal_action action="ram:GetUserMFAInfo" %}}
 
-{{% alibaba_access_management_doc %}}
-{{% alibaba_authentication_ram_api_doc %}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md" >}}
diff --git a/docs-chef-io/content/inspec/resources/alicloud_ram_users.md b/docs-chef-io/content/inspec/resources/alicloud_ram_users.md
@@ -139,5 +139,5 @@ end
 
 Your Principal will need the following permissions action with Effect set to Allow: `ram:Listusers`, `ram:GetLoginProfile`, `ram:ListAccessKeys`, `ram:GetUserMFAInfo`
 
-{{% alibaba_access_management_doc %}}
-{{% alibaba_authentication_ram_api_doc %}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}}
+{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md" >}}
diff --git a/docs-chef-io/content/inspec/resources/reusable/index.md b/docs-chef-io/content/inspec/resources/reusable/index.md
@@ -0,0 +1,5 @@
++++
+headless = true
+## headless = true makes this directory a headless bundle.
+## See https://gohugo.io/content-management/page-bundles/#headless-bundle
++++
diff --git a/...ortcodes/alibaba_access_management_doc.md → ...sable/md/alibaba_access_management_doc.md b/...ortcodes/alibaba_access_management_doc.md → ...sable/md/alibaba_access_management_doc.md
diff --git a/...des/alibaba_authentication_ecs_api_doc.md → .../md/alibaba_authentication_ecs_api_doc.md b/...des/alibaba_authentication_ecs_api_doc.md → .../md/alibaba_authentication_ecs_api_doc.md
diff --git a/...des/alibaba_authentication_ram_api_doc.md → .../md/alibaba_authentication_ram_api_doc.md b/...des/alibaba_authentication_ram_api_doc.md → .../md/alibaba_authentication_ram_api_doc.md
diff --git a/...s/shortcodes/alicloud_principal_action.md → ...pec-alicloud/alicloud_principal_action.md b/...s/shortcodes/alicloud_principal_action.md → ...pec-alicloud/alicloud_principal_action.md