Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation, e.g. fix typos #281

Merged
merged 2 commits into from
Apr 10, 2024
Merged

Improve documentation, e.g. fix typos #281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
965e0b6
Fix a bunch of typos.
headcr4sh Apr 4, 2024
2b81bfc
Merge branch 'main' into patch-1
arnaudlh Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ output "rg_example" {
}
```

```bash
```
data.azurecaf_name.rg_example: Reading...
data.azurecaf_name.rg_example: Read complete after 0s [id=a-b-rg-demogroup-sjdeh-y-z]

Expand Down Expand Up @@ -162,7 +162,7 @@ information about contributing can be found at [CONTRIBUTING.md](.github/CONTRIB

## Resource Status

This is the current compreheensive status of the implemented resources in the provider comparing with the current list of resources in the azurerm terraform provider.
This is the current comprehensive status of the implemented resources in the provider comparing with the current list of resources in the azurerm terraform provider.

|resource | status |
|---|---|
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/azurecaf_environment_variable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The data source azurecaf_environment_variable retrieve an OS environment variable.

## Exemple usage
## Example usage
This example shows how to get the value of an environment variable.

```hcl
Expand Down
3 changes: 2 additions & 1 deletion docs/data-sources/azurecaf_name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ resource "azurerm_resource_group" "rg" {
location = "southeastasia"
}
```
```bash

```
data.azurecaf_name.rg_example: Reading...
data.azurecaf_name.rg_example: Read complete after 0s [id=rg-demogroup-wjyhr]

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/azurecaf_name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ dev-aztfmod-001
```hcl
resource "azurecaf_name" "rg_example" {
name = "demogroup"
resource_type = "azurerm_resource_group"
prefixes = ["a", "b"]
suffixes = ["y", "z"]
random_length = 5
clean_input = true
resource_type = "azurerm_resource_group"
prefixes = ["a", "b"]
suffixes = ["y", "z"]
random_length = 5
clean_input = true
}

resource "azurerm_resource_group" "demo" {
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/azurecaf_naming_convention.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The resource naming_convention implements a set of methodologies to apply consis

The naming_convention is the initial resource released as part of the azurecaf provider, the naming_convention supports a fixed set of resources as described in the documention. In order to provider more flexibility and support the large breadth of Azure resources available you can use the azurecaf_name resource.

## Exemple usage
## Example usage
This example outputs one name, the result of the naming convention query. The result attribute returns the name based on the convention and parameters input.

The example generates a 23 characters name compatible with the specification for an Azure Resource Group
Expand Down Expand Up @@ -44,7 +44,7 @@ The following arguments are supported:
* prefix (optional) - prefix to append as the first characters of the generated name
* postfix (optional) - additional postfix added after the basename, this is can be used to append resource index (eg. vm-001)
* max_length (optional) - configure the maximum length of the returned object name, is the specified length is longer than the supported length of the Azure resource the later applies
* resource_type (optional) - describes the type of azure resource you are requesting a name from (eg. azure container registrly: acr). See the Resource Type section
* resource_type (optional) - describes the type of azure resource you are requesting a name from (eg. azure container registry: acr). See the Resource Type section

# Attributes Reference
The following attributes are exported:
Expand Down
Loading