Docs edits

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
inspec · Feb 19, 2022 · 12add1a · 12add1a
1 parent 530dcd4
commit 12add1a
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 24 deletions.
diff --git a/docs/resources/azure_sql_virtual_machine_group.md b/docs/resources/azure_sql_virtual_machine_group.md
@@ -5,7 +5,7 @@ platform: azure
 
 # azure_sql_virtual_machine_group
 
-Use the `azure_sql_virtual_machine_group` InSpec audit resource to test properties related to an Azure SQL Virtual Machine Group.
+Use the `azure_sql_virtual_machine_group` InSpec audit resource to test properties related to an Azure SQL virtual machine group.
 
 ## Azure REST API version, endpoint and http client parameters
 
@@ -26,7 +26,7 @@ For an example `inspec.yml` file and how to set up your Azure credentials, refer
 
 ## Syntax
 
-`name`, `resource_group` is a required parameter.
+`name`, `resource_group` are required parameters.
 
 ```ruby
 describe azure_sql_virtual_machine_group(resource_group: 'RESOURCE_GROUP', name: 'SQL_VIRTUAL_MACHINE_GROUP') do
@@ -41,15 +41,16 @@ describe azure_sql_virtual_machine_group(resource_group: 'RESOURCE_GROUP', name:
   it  { should exist }
 end
 ```
+
 ## Parameters
 
-| Name           | Description                                                                      |
-|----------------|----------------------------------------------------------------------------------|
-| name           | Name of the Azure SQL Virtual Machine Groups to test.                                   |
-| resource_group | Azure resource group that the targeted resource resides in. `MyResourceGroup`    |
+`name` _(required)_
+
+Name of the Azure SQL virtual machine group to test.
+
+`resource_group` _(required)_
 
-The parameter set should be provided for a valid query:
-- `resource_group` and `name`
+Azure resource group that the targeted resource resides in.
 
 ## Properties
 
@@ -59,7 +60,7 @@ The parameter set should be provided for a valid query:
 | name                     | Resource name.                                                   |
 | type                     | Resource type. `Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups`|
 | location                 | The Geo-location where the resource lives.                       |
-| properties               | The properties of the SQL Virtual Machine Group.                 |
+| properties               | The properties of the SQL virtual machine group.                 |
 | properties.provisioningState | State of the resource.                                       |
 
 
@@ -69,7 +70,7 @@ Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/s
 
 ## Examples
 
-### Test that the SQL Virtual Machine Group is provisioned successfully.
+### Test that the SQL virtual machine group is provisioned successfully.
 
 ```ruby
 describe azure_sql_virtual_machine_group(resource_group: 'RESOURCE_GROUP', name: 'SQL_VIRTUAL_MACHINE_GROUP') do
@@ -84,11 +85,11 @@ This InSpec audit resource has the following special matchers. For a full list o
 ### exists
 
 ```ruby
-# If a SQL Virtual Machine Group is found it will exist
+# If a SQL virtual machine group is found it will exist
 describe azure_sql_virtual_machine_group(resource_group: 'RESOURCE_GROUP', name: 'SQL_VIRTUAL_MACHINE_GROUP') do
   it { should exist }
 end
-# if SQL Virtual Machine Group is not found it will not exist
+# if SQL virtual machine group is not found it will not exist
 describe azure_sql_virtual_machine_group(resource_group: 'RESOURCE_GROUP', name: 'SQL_VIRTUAL_MACHINE_GROUP') do
   it { should_not exist }
 end

diff --git a/docs/resources/azure_sql_virtual_machine_groups.md b/docs/resources/azure_sql_virtual_machine_groups.md
@@ -5,7 +5,7 @@ platform: azure
 
 # azure_sql_virtual_machine_groups
 
-Use the `azure_sql_virtual_machine_groups` InSpec audit resource to test properties related to all Azure SQL Virtual Machine Groups.
+Use the `azure_sql_virtual_machine_groups` InSpec audit resource to test properties related to all Azure SQL virtual machine groups.
 
 ## Azure REST API version, endpoint and http client parameters
 
@@ -35,29 +35,27 @@ end
 ```
 
 ## Parameters
-| Name           | Description                                                                      |
-|----------------|----------------------------------------------------------------------------------|
-| resource_group | Azure resource group that the targeted resource resides in. `MyResourceGroup` (Optional)   |
 
-The parameter set optionally be provided for a valid query:
-- `resource_group`
+`resource_group` _(optional)_
+
+Azure resource group that the targeted resource resides in.
 
 ## Properties
 
 |Property                        | Description                                                            | Filter Criteria<superscript>*</superscript> |
 |--------------------------------|------------------------------------------------------------------------|------------------|
 | ids                            | A list of resource IDs.                                                | `id`             |
-| names                          | A list of resource Names.                                              | `name`           |
+| names                          | A list of resource names.                                              | `name`           |
 | types                          | A list of the resource types.                                          | `type`           |
-| properties                     | A list of Properties for all the SQL Virtual Machine Groups.           | `properties`     |
-| locations                      | A list of the Geo-locations.                                           | `location`       |
-| provisioningStates             | A list of provisioning states of the SQL Virtual Machine Groups.       | `provisioningState`|
+| properties                     | A list of properties for all the SQL virtual machine groups.           | `properties`     |
+| locations                      | A list of the resource locations.                                      | `location`       |
+| provisioningStates             | A list of provisioning states of the SQL virtual machine groups.       | `provisioningState`|
 
 <superscript>*</superscript> For information on how to use filter criteria on plural resources refer to [FilterTable usage](https://github.com/inspec/inspec/blob/master/dev-docs/filtertable-usage.md).
 
 ## Examples
 
-### Loop through SQL Virtual Machine Groups by their names.
+### Loop through SQL virtual machine groups by their names.
 
 ```ruby
 azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP').names.each do |name|
@@ -66,7 +64,8 @@ azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP').names.each do
   end
 end
 ```
-### Test that there are SQL Virtual Machine Groups that are successfully provisioned.
+
+### Test that there are SQL virtual machine groups that are successfully provisioned.
 
 ```ruby
 describe azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do