Resource Docs cleanup - For Clinton's Review #663
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Deepa Kumaraswamy <[email protected]>
✅ Deploy Preview for inspec-azure ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
soumyo13
reviewed
Nov 2, 2022
| @@ -142,9 +142,9 @@ end | |||
|
|
|||
| {{% inspec_matchers_link %}} | |||
|
|
|||
| ### exists | |||
| ### Exists | |||
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
reviewed
Nov 2, 2022
| end | ||
| ``` | ||
|
|
||
| ## Matchers | ||
|
|
||
| {{% inspec_matchers_link %}} | ||
|
|
||
| ### exists | ||
| ### Exists |
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
reviewed
Nov 2, 2022
| @@ -85,16 +90,20 @@ end | |||
|
|
|||
| This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://docs.chef.io/inspec/matchers/). | |||
|
|
|||
| ### exists | |||
| ### Exists | |||
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
reviewed
Nov 2, 2022
| @@ -86,15 +86,19 @@ end | |||
|
|
|||
| This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://docs.chef.io/inspec/matchers/). | |||
|
|
|||
| ### exists | |||
| ### Exists | |||
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
reviewed
Nov 2, 2022
|
|
||
| ```ruby | ||
| # If a dataset should exist | ||
|
|
||
| describe azure_data_factory_dataset(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME', dataset_name: 'DATASET_NAME') do | ||
| it { should exist } | ||
| end | ||
| ``` | ||
|
|
||
| ### Not Exists |
There was a problem hiding this comment.
Suggested change
| ### Not Exists |
soumyo13
reviewed
Nov 2, 2022
| @@ -93,16 +90,20 @@ end | |||
|
|
|||
| This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](/inspec/matchers/). | |||
|
|
|||
| ### exists | |||
| ### Exists | |||
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
reviewed
Nov 2, 2022
|
|
||
| # DDoS protection plan resources that aren't found will not exist | ||
| ### Not Exists |
There was a problem hiding this comment.
Suggested change
| ### Not Exists |
soumyo13
reviewed
Nov 2, 2022
| @@ -103,7 +101,7 @@ end | |||
|
|
|||
| {{% inspec_matchers_link %}} | |||
|
|
|||
| ### exists | |||
| ### Exists | |||
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
reviewed
Nov 2, 2022
| @@ -82,18 +85,22 @@ end | |||
|
|
|||
| This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://docs.chef.io/inspec/matchers/). | |||
|
|
|||
| ### exists | |||
| ### Exists | |||
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
reviewed
Nov 2, 2022
| it { should exist } | ||
| end | ||
| ``` | ||
|
|
||
| ### Not Exists |
There was a problem hiding this comment.
Suggested change
| ### Not Exists |
soumyo13
reviewed
Nov 2, 2022
| For more examples, please see the [integration tests](/test/integration/verify/controls/azure_generic_resource.rb). | ||
|
|
||
| ## Matchers | ||
|
|
||
| {{% inspec_matchers_link %}} | ||
|
|
||
| ### exist | ||
| ### Exists |
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
reviewed
Nov 2, 2022
| it { should_not exist } | ||
| end | ||
| ``` | ||
|
|
||
| ### Not Exists |
There was a problem hiding this comment.
Suggested change
| ### Not Exists |
soumyo13
reviewed
Nov 2, 2022
| @@ -217,24 +219,26 @@ For more examples, please see the [integration tests](/test/integration/verify/c | |||
|
|
|||
| {{% inspec_matchers_link %}} | |||
|
|
|||
| ### exist | |||
| ### Exists | |||
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
reviewed
Nov 2, 2022
| it { should_not exist } | ||
| end | ||
| ``` | ||
|
|
||
| ### Not Exists |
There was a problem hiding this comment.
Suggested change
| ### Not Exists |
soumyo13
reviewed
Nov 2, 2022
| @@ -88,18 +91,22 @@ end | |||
|
|
|||
| This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://docs.chef.io/inspec/matchers/). | |||
|
|
|||
| ### exists | |||
| ### Exists | |||
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
reviewed
Nov 2, 2022
| it { should exist } | ||
| end | ||
| ``` | ||
|
|
||
| ### Not Exists |
There was a problem hiding this comment.
Suggested change
| ### Not Exists |
soumyo13
reviewed
Nov 2, 2022
| it { should exist } | ||
| end | ||
| ``` | ||
|
|
||
| ### Not Exists |
There was a problem hiding this comment.
Suggested change
| ### Not Exists |
soumyo13
reviewed
Nov 2, 2022
| @@ -97,7 +97,7 @@ end | |||
|
|
|||
| {{% inspec_matchers_link %}} | |||
|
|
|||
| ### exists | |||
| ### Exists | |||
There was a problem hiding this comment.
Suggested change
| ### Exists | |
| ### exists |
soumyo13
suggested changes
Nov 2, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Deepa Kumaraswamy [email protected]
Description
Around 10-12 InSpec Azure resource files are reviewed for language, Chef House style, formattings, headings, etc. These are shared with Clinton for his input and direction before massive cleanup work for entire Azure, AWS, and InSpec resources commences.
Issues Resolved
List any existing issues this PR resolves, or any Discourse or StackOverflow discussion that's relevant
Check List
rake lintpasses