Merge pull request #1149 from Thorium/fix-doc

Minor corrections to the documentation wording

docs/content/_index.md

@@ -20,7 +20,7 @@ Farmer is an easy-to-learn library for rapidly authoring and deploying entire Az
 Farmer has you covered.
 
 * **Farmer is completely backwards compatible with ARM templates**. Farmer generates standard ARM templates so you can continue to use existing deployment processes.
-* **Safely create dependencies between resources**. Uses static typing to give confidence that your templates will work first time.
+* **Safely create dependencies between resources**. Uses static typing to give confidence that your templates will work the first time.
 * **Easily access common properties of resources**. No more fighting to concatenate cryptic strings!
 * **Extensible API**. Add new helpers and members as needed.
 * **Open source and free**. Farmer is free to use and modify. We welcome contributions to the project!

docs/content/api-overview/basic-types.md

@@ -39,7 +39,7 @@ let mySubnet = {
 }
 ```
 
-These resource can be used i.e. in referencing a `web app { }` to a subnet.
+These resources can be used i.e. in referencing a `web app { }` to a subnet.
 
 ```fsharp
 let webApp = webApp {
@@ -48,4 +48,4 @@ let webApp = webApp {
     sku WebApp.Sku.B1
     link_to_unmanaged_vnet mySubnet
 }
-```
+```

docs/content/api-overview/dependencies.md

@@ -65,7 +65,7 @@ let myApp = webApp {
 }
 ```
 
-Notice the extra type hint, `: IBuilder list`. This is required because F# does not, by default, allow you to implicitly treat a list of values as a supertype. In this case, a `StorageAccountConfig list` is not considered implicitly convertable to `: IBuilder list` (which is an interface that `StorageAccountConfig` implements). Therefore, we have to do it ourselves using the extra type declaration.
+Notice the extra type hint, `: IBuilder list`. This is required because F# does not, by default, allow you to implicitly treat a list of values as a supertype. In this case, a `StorageAccountConfig list` is not considered implicitly convertible to `: IBuilder list` (which is an interface that `StorageAccountConfig` implements). Therefore, we have to do it ourselves using the extra type declaration.
 
 You can also use the `:>` (safe upcast) operator when declaring the StorageAccount:
 
@@ -84,4 +84,4 @@ All builders that support dependencies support a number of `depends_on` overload
 
 * A single, or a list of, Builders (as shown above)
 * A single, or a list of, resources by their Name
-* A single, or a list of, [IArmResources](../../contributing/adding-resources/2-iarm-resource/)
+* A single, or a list of, [IArmResources](../../contributing/adding-resources/2-iarm-resource/)

docs/content/api-overview/expressions.md

@@ -11,7 +11,7 @@ Farmer understands how to use ARM expressions and provides functionality to corr
 > For manipulation of literal values that are known in your Farmer applications, you will not need to use ARM expressions. To manipulate such values, you can use standard F# and .NET capabilities.
 
 #### How do I use ARM expressions?
-Many Farmer builders contain pre-defined ARM expression that can be used for common tasks, such as passing a connection string from a storage account as a KeyVault secret, or a web application setting.
+Many Farmer builders contain pre-defined ARM expressions that can be used for common tasks, such as passing a connection string from a storage account as a KeyVault secret, or a web application setting.
 
 As an example, a Storage Account config contains a `Key` member that you can supply to a web app as a setting:
 
@@ -36,7 +36,7 @@ This will be written to the ARM template file as follows:
             }
 ```
 
-Using ARM expressions means that you can deploy an application which is automatically configured at deployment time. This means that you never need to store an application secret such as a storage account key in source control, or even e.g. as a secret variable in your build / deployment process.
+Using ARM expressions means that you can deploy an application which is automatically configured at deployment time. This means that you never need to store an application secret, such as a storage account key in source control, or even e.g. as a secret variable in your build / deployment process.
 
 #### Returning the value of ARM Expressions as outputs.
 ARM Expressions can also be passed back as *outputs* and used further downstream once your deployment is complete:

docs/content/api-overview/parameters.md

@@ -29,7 +29,7 @@ let db = sql {
 }
 ```
 
-This will generate an ARM template which looks as follows (irrelevant content is elided for clarity):
+This will generate an ARM template which looks as follows (irrelevant content is omitted for clarity):
 
 ```json
 {
@@ -54,7 +54,7 @@ This will generate an ARM template which looks as follows (irrelevant content is
 ```
 
 #### Working with variables
-ARM templates allow you to declare [variables](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/template-variables) inside a template to reuse a value across a template. ARM templates also allow the use of a custom set of a commands which are embedded within strings to generate program logic, using *expressions* which contain [*template functions*](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/template-functions). For example, to concatenate a string inside a ARM template made up of two variables and put into a third variable, you might use something like the following:
+ARM templates allow you to declare [variables](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/template-variables) inside a template to reuse a value across a template. ARM templates also allow the use of a custom set of commands which are embedded within strings to generate program logic, using *expressions* which contain [*template functions*](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/template-functions). For example, to concatenate a string inside an ARM template made up of two variables and put into a third variable, you might use something like the following:
 
 ```json
 {
@@ -100,4 +100,4 @@ let deployment = arm {
     location Location.NorthEurope
     add_resources myDatabases
 }
-```
+```

docs/content/api-overview/resources/aks-cluster.md

@@ -109,7 +109,7 @@ let myAks = aks {
     )
 }
 ```
-#### Using user asssigned identities and connecting to container registry
+#### Using user assigned identities and connecting to the container registry
 ```fsharp
 // Create an identity for kubelet (used to connect to container registry)
 let kubeletMsi = createUserAssignedIdentity "kubeletIdentity"
@@ -160,4 +160,4 @@ let template =
         add_resource assignMsiRole
         add_resource acrPullRole
     }
-```
+```

docs/content/api-overview/resources/alert.md

@@ -20,13 +20,13 @@ Azure Application Insights allows you to monitor your application and send you a
 | frequency | How often the metric alert is evaluated |
 | window | The period of time that is used to monitor alert activity based on the threshold. |
 | severity | Alert severity |
-| add_linked_resource | Add target resource on which the alert is created/updated.  |
+| add_linked_resource | Add the target resource on which the alert is created/updated.  |
 | add_linked_resources | Add the target resources on which the alert is created/updated. |
 | single_resource_multiple_metric_criteria | The rule criteria that defines the conditions of the alert rule. |
-| single_resource_multiple_custom_metric_criteria | The rule criteria that defines the conditions of the alert rule based on Application Insights custom metric or metric with custom namespace. Metric validation is disabled for such criteria, so it is possible to create an alert that watches metrics not yet emitted. More details are available [here](https://docs.microsoft.com/azure/azure-monitor/platform/alerts-troubleshoot-metric#define-an-alert-rule-on-a-custom-metric-that-isnt-emitted-yet). |
+| single_resource_multiple_custom_metric_criteria | The rule criteria that defines the conditions of the alert rule based on Application Insights custom metric or metric with a custom namespace. Metric validation is disabled for such criteria, so it is possible to create an alert that watches metrics not yet emitted. More details are available [here](https://docs.microsoft.com/azure/azure-monitor/platform/alerts-troubleshoot-metric#define-an-alert-rule-on-a-custom-metric-that-isnt-emitted-yet). |
 | multiple_resource_multiple_metric_criteria | The rule criterias that defines the conditions of the alert rule. |
 | webtest_location_availability_criteria | The rule criteria that defines the conditions of the alert rule. AppInsightsId * WebTestId * FailedLocationCount |
-| add_action | Add an action that are performed when the alert rule becomes active. |
+| add_action | Add an action that is performed when the alert rule becomes active. |
 
 More detailed documentation: https://docs.microsoft.com/en-us/azure/templates/microsoft.insights/metricalerts?tabs=json#metricalertproperties
 

docs/content/api-overview/resources/app-insights.md

@@ -19,7 +19,7 @@ The App Insights builder is used to create Application Insights accounts. Use th
 | name | Sets the name of the App Insights instance. |
 | disable_ip_masking | Disable IP masking. |
 | sampling_percentage | Define sampling percentage (0-100) |
-| log_analytics_workspace | Use a Log Analytics workspace as the backing store for this AI instance. You can supply either a Farmer-generate Log Analytics`WorkspaceConfig` instance that exists in the same resource group, or a fully-qualified Resource ID path to that instance. This will also switch the AI instance over to creating a "workspace enabled" AI instance. |
+| log_analytics_workspace | Use a Log Analytics workspace as the backing store for this AI instance. You can supply either a Farmer-generate Log Analytics`WorkspaceConfig` instance that exists in the same resource group, or a fully-qualified Resource ID path to that instance. This will also switch the AI instance over to create a "workspace enabled" AI instance. |
 
 #### Configuration Members
 
@@ -38,4 +38,4 @@ let ai = appInsights {
     name "myAI"
     log_analytics_workspace myWorkspace // use to activate workspace-enabled AI instances.
 }
-```
+```

docs/content/api-overview/resources/availability-tests.md

@@ -7,7 +7,7 @@ chapter: false
 
 #### Overview
 The App Insights - Availability Tests builder is used to create Application Insights Availability Tests. You will need an Application Insights instance to run the tests.
-The tests can be just pinging the website and expecting response code of 200, or they can be recored Visual Studio WebTests as custom XML strings.
+The tests can be just pinging the website and expecting a response code of 200, or they can be recorded Visual Studio WebTests as custom XML strings.
 
 * Application Insights (`Microsoft.Insights/webtests`)
 
@@ -46,4 +46,4 @@ let myAvailabilityTest =
             |> System.Uri 
             |> AvailabilityTest.WebsiteUrl)
     }
-```
+```

docs/content/api-overview/resources/azure-firewall.md

@@ -16,13 +16,13 @@ The Azure Firewall builder (`azureFirewall`) is used to create Azure Firewall in
 | Resource       | Keyword              | Purpose                                                                |
 | -------------- | -------------------- | -----------------------------------------------------------------------|
 | azureFirewall           | name | Sets the name of the azure firewall |
-| azureFirewall           | sku | Sets the name and tier of the azure firewall sku |
+| azureFirewall           | sku | Sets the name and tier of the Azure firewall sku |
 | azureFirewall           | link_to_unmanaged_firewall_policy | Configure the azure firewall to use an existing firewall policy |
-| azureFirewall           | link_to_firewall_policy | Configure the azure firewall to use a firewall policy deployed by Farmer |
+| azureFirewall           | link_to_firewall_policy | Configure the Azure firewall to use a firewall policy deployed by Farmer |
 | azureFirewall           | link_to_unmanaged_vhub | Specify the existing virtual hub to which the azure firewall belongs |
-| azureFirewall           | link_to_vhub | Specify the virtual hub deployed by farmer to which the azure firewall belongs |
+| azureFirewall           | link_to_vhub | Specify the virtual hub deployed by Farmer to which the azure firewall belongs |
 | azureFirewall           | public_ip_reservation_count | Specify the number of Public IP addresses associated with the azure firewall |
-| azureFirewall           | depends_on | Specify resources deployed by farmer the azure firewall depends on |
+| azureFirewall           | depends_on | Specify resources deployed by Farmer the azure firewall depends on |
 
 ### Example
 
@@ -41,4 +41,4 @@ let deployment = arm {
     location Location.NorthEurope
     add_resource firewall
 }
-```
+```

docs/content/api-overview/resources/bastion-host.md

@@ -16,12 +16,12 @@ The Bastion Host builder creates a bastion host to access resources inside a vir
 |------------|-----------------------|----------------------------------------------------------------------------------------------------------------------|
 | `bastion`  | vnet                  | Name of the virtual network the bastion host can access.                                                             |
 | `bastion`  | link_to_vnet          | Link to an existing virtual network (no dependsOn emitted.                                                           |
-| `bastion`  | scale_units           | Number of scale units when more connections are needed. Default is 2 and more scale units will use the Standard SKU. |
-| `bastion`  | disable_copy_paste    | Disables copy and paste to and from the bastion - enabling this upgrades to the Standard SKU.                        |
+| `bastion`  | scale_units           | Number of scale units when more connections are needed. The default is 2 and more scale units will use the Standard SKU. |
+| `bastion`  | disable_copy_paste    | Disables copy and paste to and from the bastion - enabling this upgrade to the Standard SKU.                        |
 | `bastion`  | dns_name              | Set the DNS name for accessing the bastion host.                                                                     |
 | `bastion`  | enable_file_copy      | Upload and download files to the target VM.                                                                          |
 | `bastion`  | enable_ip_connect     | Connect to virtual machines by IP address instead of using their target resource Id.                                 |
-| `bastion`  | enable_kerberos       | Enable kerberos authentication support for supporting scenarios such as Windows Single Sign On.                      |
+| `bastion`  | enable_kerberos       | Enable Kerberos authentication support for supporting scenarios such as Windows Single Sign On.                      |
 | `bastion`  | enable_shareable_link | lets users connect to a target resource using Azure Bastion without accessing the Azure portal.                      |
 | `bastion`  | enable_tunneling      | Set up tunnels through the bastion host so native client tools can be used.                                          |
 

docs/content/api-overview/resources/cdn.md

@@ -27,7 +27,7 @@ There are three builders available:
 | Keyword | Purpose |
 |-|-|
 | name | Sets the name of the endpoint instance. If you do not set this, a name is generated based on the origin. |
-| origin | Sets the address of the origin and is used to auto-generate the endpoint name if none if supplied. |
+| origin | Sets the address of the origin and is used to auto-generate the endpoint name if none is supplied. |
 | depends_on | [Sets dependencies on this endpoint](../../dependencies/). |
 | add_compressed_content | Adds a set of content types to compress. |
 | query_string_caching_behaviour | Specifies the Query String Caching Behaviour. |
@@ -107,4 +107,4 @@ let isaacCdn = cdn {
         }
     ]
 }
-```
+```

docs/content/api-overview/resources/container-apps.md

@@ -17,7 +17,7 @@ Before you deploy your container app, you need to turn on the Container Apps res
 Get sure you have the following providers registered: `Microsoft.Kubernetes` and `Microsoft.ContainerService`.
 
 #### Container Environment Builder
-The Container Environment builder (`containerEnvironment`) defines settings for the Kubernetes envirionment that hosts the container apps.
+The Container Environment builder (`containerEnvironment`) defines settings for the Kubernetes environment that hosts the container apps.
 
 | Keyword | Purpose |
 |-|-|
@@ -28,7 +28,7 @@ The Container Environment builder (`containerEnvironment`) defines settings for
 | add_container | Adds a single container app to the environment. |
 | add_containers | Adds one or more container apps to the environment. |
 | add_dapr_component | Adds a dapr component to the environment. |
-| add_dapr_components | Adds one or more dapr component to the environment. |
+| add_dapr_components | Adds one or more dapr components to the environment. |
 | app_insights_instance | Links an App Insights instance to this environment. All containers will be configured to use this AI instance, as well as DAPR. |
 
 > Also supports Tagging and Dependencies.
@@ -47,7 +47,7 @@ The Container Apps builder (`containerApp`) is used to define one or more contai
 | dapr_app_id | Sets the dapr app id for the app. |
 | dapr_app_port | Sets the dapr app port for the app. |
 | replicas | Sets the minimum and maximum replicas to scale the container app. |
-| active_revision_mode | Indicates whether multiple version of a container app can be active at once.|
+| active_revision_mode | Indicates whether multiple versions of a container app can be active at once.|
 | add_registry_credentials | Adds container image registry credentials for images in this container app, which are a list of server and usernames. Passwords are supplied as secure parameters. |
 | reference_registry_credentials | Adds container image registry credentials for images in this container app in the form of a list of Azure resource ids. |
 | add_managed_identity_registry_credentials | Adds container app registry managed identity credentials for images in this container app, which are a list of server and identities. |
@@ -56,7 +56,7 @@ The Container Apps builder (`containerApp`) is used to define one or more contai
 | add_secret_parameter | Adds an application secret to the entire container app. This is passed as a secure parameter to the template, and an environment variable is automatically created which references the secret. |
 | add_secret_parameters | Adds application secrets to the entire container app. This is passed as secure parameters to the template, and environment variables are automatically created which reference the secret. |
 | add_secret_expression | As per `add_secret_parameter`, but the value is sourced from an ARM expression instead of as a parameter. Useful for e.g. storage keys etc. |
-| add_secret_expressions | As per `add_secret_parameters`, but the values are sourced from an ARM expressions instead of as parameters. Useful for e.g. storage keys etc. |
+| add_secret_expressions | As per `add_secret_parameters`, but the values are sourced from ARM expressions instead of as parameters. Useful for e.g. storage keys etc. |
 | add_env_variable | Adds a static, plain text environment variable. |
 | add_env_variables | Adds static, plain text environment variables. |
 | add_volumes | Adds volumes to a container app so they are accessible to containers. |
@@ -101,7 +101,7 @@ The Dapr Component builder (`daprComponent`) is used to define one or more dapr
 | add_metadata | Adds a piece of metadata to the dapr component. |
 | add_secret_metadata | Adds a piece of metadata that references a secret to the dapr component. |
 | add_scope | Adds a scope, can either be a string or a reference to a container app. |
-| add_scopes | Adds one or more scopes, can either be strings or references to container apps. |
+| add_scopes | Adds one or more scopes, which can either be strings or references to container apps. |
 | version | Sets the dapr component version. |
 | cron_binding | Helper for setting fields required for a cron binding |
 | azure_storage_queue_binding | Helper for setting fields required for an Azure Storage Queue binding |