Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-27 15:10:44 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fixes partially indented blocks and unescaped underscores (#2731)

Browse source 
Moved 2 space examples 2 more spaces in. Don't be shy, show the world your code the way it was meant to be seen.

Underscores in markdown must be escaped otherwise the world goes crooked.

Signed-off-by: Franklin Webber <franklin@chef.io>
This commit is contained in:
Franklin Webber 2018-02-26 10:11:06 -06:00 committed by Jared Quick
parent 9f07f0899d
commit a359399fa0
9 changed files with 51 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/resources/aws_ec2_instance.md.erb
View file

@ -65,7 +65,7 @@ This InSpec audit resource has the following special matchers. For a full list o
### be\_pending
The `be\_pending` matcher tests if the described EC2 instance state is `pending`. This indicates that an instance is provisioning. This state should be temporary.
The `be_pending` matcher tests if the described EC2 instance state is `pending`. This indicates that an instance is provisioning. This state should be temporary.
it { should be_pending }

4
docs/resources/aws_iam_policy.md.erb
View file

@ -9,7 +9,7 @@ Use the `aws_iam_policy` InSpec audit resource to test properties of a single ma
A policy is an entity in AWS that, when attached to an identity or resource, defines their permissions. AWS evaluates these policies when a principal, such as a user, makes a request. Permissions in the policies determine if the request is allowed or denied.
Each IAM Policy is uniquely identified by either its policy_name or arn.
Each IAM Policy is uniquely identified by either its policy\_name or arn.
<br>
@ -142,5 +142,3 @@ The test will pass if the identified policy attached the specified role.
describe aws_iam_policy('AWSSupportAccess') do
it { should be_attached_to_role(ROLENAME) }
end

4
docs/resources/aws_iam_role.md.erb
View file

@ -52,7 +52,7 @@ This InSpec audit resource has the following special matchers. For a full list o
### exist
Indicates that the Role Name provided was found. Use should_not to test for IAM Roles that should not exist.
Indicates that the Role Name provided was found. Use `should_not` to test for IAM Roles that should not exist.
describe aws_iam_role('should-be-there') do
it { should exist }
@ -61,5 +61,3 @@ Indicates that the Role Name provided was found. Use should_not to test for IAM
describe aws_iam_role('should-not-be-there') do
it { should_not exist }
end

2
docs/resources/aws_route_table.md.erb
View file

@ -36,7 +36,7 @@ For a full list of available matchers, please visit our [matchers page](https://
### exist
Indicates that the Route Table provided was found. Use should_not to test for Route Tables that should not exist.
Indicates that the Route Table provided was found. Use `should_not` to test for Route Tables that should not exist.
describe aws_route_table('should-be-there') do
it { should exist }

3
docs/resources/aws_security_group.md.erb
View file

@ -138,7 +138,7 @@ This InSpec audit resource has the following special matchers. For a full list o
### exists
The control will pass if the specified SG was found. Use should_not if you want to verify that the specified SG does not exist.
The control will pass if the specified SG was found. Use `should_not` if you want to verify that the specified SG does not exist.
# You will always have at least one SG, the VPC default SG
describe aws_security_group(group_name: 'default')
@ -149,4 +149,3 @@ The control will pass if the specified SG was found. Use should_not if you want
describe aws_security_group(group_name: 'nogood')
it { should_not exist }
end

3
docs/resources/aws_security_groups.md.erb
View file

@ -54,7 +54,7 @@ A string identifying a group. Since groups are contained in VPCs, group names ar
## Properties
* `entries`, `group\_ids`
* `entries`, `group_ids`
<br>
@ -89,4 +89,3 @@ The control will pass if the filter returns at least one result. Use `should_not
describe aws_security_groups
it { should exist }
end

4
docs/resources/aws_sns_topic.md.erb
View file

@ -27,7 +27,7 @@ Use the `aws_sns_topic` InSpec audit resource to test properties of a single AWS
This resource expects a single parameter that uniquely identifes the SNS Topic, an ARN. Amazon Resource Names for SNS topics have the format `arn:aws:sns:region:account-id:topicname`. AWS requires a fully-specified ARN for looking up an SNS topic. The account ID and region are required. Wildcards are not permitted.
See also the (AWS documentation on ARNs)[http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html].
See also the [AWS documentation on ARNs](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
<br>
@ -50,7 +50,7 @@ This InSpec audit resource has the following special matchers. For a full list o
### exist
Indicates that the ARN provided was found. Use should_not to test for SNS topics that should not exist.
Indicates that the ARN provided was found. Use `should_not` to test for SNS topics that should not exist.
# Expect good news
describe aws_sns_topic('arn:aws:sns:*::good-news') do

1
docs/resources/crontab.md.erb
View file

@ -68,6 +68,7 @@ The following examples show how to use this InSpec audit resource.
## Property Examples
### Test a special time string
describe crontab do