Skip to content

Commit

Permalink
Fixing documentation lint failures
Browse files Browse the repository at this point in the history
  • Loading branch information
JaylonmcShan03 committed Jan 14, 2025
1 parent c896dd7 commit bd21dee
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/data-sources/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,3 +229,4 @@ output "mariadb_instance_notes" {
value = data.helm_template.mariadb_instance.notes
}
```

12 changes: 12 additions & 0 deletions docs/guides/v3-upgrade-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ The Helm provider has been migrated from the legacy [Terraform Plugin SDKv2](htt
The `kubernetes` block has been updated to a single nested object.

**Old SDKv2 Configuration:**

```hcl
provider "helm" {
kubernetes {
Expand All @@ -48,6 +49,7 @@ provider "helm" {
```

**New Plugin Framework Configuration:**

```hcl
provider "helm" {
kubernetes = {
Expand All @@ -70,6 +72,7 @@ provider "helm" {
```

**What Changed?**

- `kubernetes` is now a single nested object using `{ ... }`.
- `registry` blocks have been replaced by a `registries` list.

Expand All @@ -78,6 +81,7 @@ provider "helm" {
The `experiments` block has been updated to a list of nested objects.

**Old SDKv2 Configuration:**

```hcl
provider "helm" {
experiments {
Expand All @@ -87,6 +91,7 @@ provider "helm" {
```

**New Plugin Framework Configuration:**

```hcl
provider "helm" {
experiments = [
Expand All @@ -98,6 +103,7 @@ provider "helm" {
```

**What Changed?**

- `experiments` is now a single nested object using `[ { ... } ]`.

### Changes to helm_release Resource
Expand All @@ -107,6 +113,7 @@ provider "helm" {
Attributes `set`, `set_list`, and `set_sensitive` are now represented as lists of nested objects instead of individual blocks.

**Old SDKv2 Configuration:**

```hcl
resource "helm_release" "nginx_ingress" {
name = "nginx-ingress-controller"
Expand All @@ -132,6 +139,7 @@ resource "helm_release" "nginx_ingress" {
```

**New Plugin Framework Configuration:**

```hcl
resource "helm_release" "nginx_ingress" {
name = "nginx-ingress-controller"
Expand Down Expand Up @@ -163,6 +171,7 @@ resource "helm_release" "nginx_ingress" {
```

**What Changed?**

- `set`, `set_list`, and `set_sensitive` is now a list of nested objects using `[ { ... } ]`.

### Changes to helm_template Data Source
Expand All @@ -172,6 +181,7 @@ resource "helm_release" "nginx_ingress" {
Attributes `set`, `set_list`, and `set_sensitive` are now represented as lists of nested objects instead of individual blocks.

**Old SDKv2 Configuration:**

```hcl
data "helm_template" "example" {
name = "my-release"
Expand All @@ -197,6 +207,7 @@ data "helm_template" "example" {
```

**New Plugin Framework Configuration:**

```hcl
data "helm_template" "example" {
name = "my-release"
Expand Down Expand Up @@ -228,4 +239,5 @@ data "helm_template" "example" {
```

**What Changed?**

- `set`, `set_list`, and `set_sensitive` is now a list of nested objects using `[ { ... } ]`.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,4 +211,4 @@ provider "helm" {
}
]
}
```
```

0 comments on commit bd21dee

Please sign in to comment.