Skip to content

Commit

Permalink
Fix-up docs templates
Browse files Browse the repository at this point in the history 
We've updated the version of tfplugin-docs which has exposed issues with
the existing resource templates.  As a result of a change in indentation
in the generated "description" field of the the .md files resulting from
the resource templates the documentation wasn't being categorised
correctly on the provider registry landing page.  To fix this we make
the following change in each template:

  {{ .Description | plainmarkdown | trimspace | prefixlines "  " }}

becomes

{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
  • Loading branch information
@eamonnotoole
eamonnotoole committed Jun 10, 2024
1 parent 09231bc commit 8f453b5
Show file tree
Hide file tree
Showing 14 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion templates/resources/vmaas_dhcp_server.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_dhcp_server Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

-> Compatible version >= 5.2.13
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_instance.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_instance Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

-> Compatible version >= 5.2.4
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_instance_clone.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_instance_clone Resource - vmaas-terraform-resources-clone"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

-> Compatible version >= 5.2.4
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_load_balancer.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_load_balancer Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# Resource hpegl_vmaas_load_balancer
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_load_balancer_monitor.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_load_balancer_monitor Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# Resource hpegl_vmaas_load_balancer_monitor
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_load_balancer_pool.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_load_balancer_pool Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# Resource hpegl_vmaas_load_balancer_pool
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_load_balancer_profile.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_load_balancer_profile Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# Resource hpegl_vmaas_load_balancer_profile
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_load_balancer_virtual_server.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_load_balancer_virtual_server Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# Resource hpegl_vmaas_load_balancer_virtual_server
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_network.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_network Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

-> Compatible version >= 5.2.13
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_router.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_router Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# Resource hpegl_vmaas_router
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_router_bgp_neighbor.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_router_bgp_neighbor Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

-> Compatible version >= 5.2.12
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_router_firewall_rule_group.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_router_firewall_rule_group Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

-> Compatible version >= 5.2.12
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_router_nat_rule.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_router_nat_rule Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

-> Compatible version >= 5.2.10
Expand Down
2 changes: 1 addition & 1 deletion templates/resources/vmaas_router_route.md.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ""
page_title: "hpegl_vmaas_router_route Resource - vmaas-terraform-resources"
subcategory: {{ $arr := split .Name "_" }}"{{ index $arr 1 }}"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

-> Compatible version >= 5.2.12
Expand Down

0 comments on commit 8f453b5

Please sign in to comment.