Skip to content

Commit

Permalink
docs: remove terraform providers section and document only requirements
Browse files Browse the repository at this point in the history
Also it appears the TF registry doesn't show provider versions anyway,
and only publishes constraints.
  • Loading branch information
JohannesRudolph committed Dec 2, 2024
1 parent c22e8b4 commit 51fa0ca
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 30 deletions.
4 changes: 4 additions & 0 deletions .terraform-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,7 @@ output:
sort:
enabled: true
by: name

sections:
hide: # we remove the providers section because the actual provider used depends on the local build environment, we only document version constraints
- providers
7 changes: 0 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,13 +175,6 @@ Before opening a Pull Request, please do the following:
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | >=3.0.2 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | >=4.11.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 3.0.2 |
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 4.11.0 |

## Modules

| Name | Source | Version |
Expand Down
8 changes: 0 additions & 8 deletions modules/meshcloud-metering-service-principal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,6 @@
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | >=3.0.2 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | >=4.11.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 3.0.2 |
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 4.11.0 |
| <a name="provider_time"></a> [time](#provider\_time) | 0.12.1 |

## Modules

No modules.
Expand Down
9 changes: 0 additions & 9 deletions modules/meshcloud-replicator-service-principal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,6 @@
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | >=3.0.2 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | >=4.11.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 3.0.2 |
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 4.11.0 |
| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
| <a name="provider_time"></a> [time](#provider\_time) | 0.12.1 |

## Modules

No modules.
Expand Down
6 changes: 0 additions & 6 deletions modules/meshcloud-sso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | > 1.0 |
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | >=3.0.2 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 3.0.2 |

## Modules

No modules.
Expand Down

0 comments on commit 51fa0ca

Please sign in to comment.