GCLOUD2-13375: Enhanced load balancer docs

G-Core · Feb 16, 2024 · 1256e15 · 1256e15
1 parent fa76cdc
commit 1256e15
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 40 deletions.
diff --git a/docs/resources/lblistener.md b/docs/resources/lblistener.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "gcore_lblistener Resource - terraform-provider-gcore"
 subcategory: ""
 description: |-

diff --git a/docs/resources/lbmember.md b/docs/resources/lbmember.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "gcore_lbmember Resource - terraform-provider-gcore"
 subcategory: ""
 description: |-

diff --git a/docs/resources/lbpool.md b/docs/resources/lbpool.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "gcore_lbpool Resource - terraform-provider-gcore"
 subcategory: ""
 description: |-

diff --git a/docs/resources/loadbalancerv2.md b/docs/resources/loadbalancerv2.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "gcore_loadbalancerv2 Resource - terraform-provider-gcore"
 subcategory: ""
 description: |-

diff --git a/docs/resources/subnet.md b/docs/resources/subnet.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "gcore_subnet Resource - terraform-provider-gcore"
 subcategory: ""
 description: |-

diff --git a/templates/resources/lblistener.md.tmpl b/templates/resources/lblistener.md.tmpl
@@ -1,15 +1,10 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "gcore_lblistener Resource - terraform-provider-gcore"
+page_title: "{{ .Name }} {{ .Type }} - {{ .ProviderName	}}"
 subcategory: ""
 description: |-
-  Represent load balancer listener. Can not be created without load balancer. A listener is a process that checks for connection requests, using the protocol and port that you configure
+  {{ .Description }}
 ---
 
-{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates.
-
-For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}}
-
 # {{ .Name }} ({{ .Type }})
 
 {{ .Description }}

diff --git a/templates/resources/lbmember.md.tmpl b/templates/resources/lbmember.md.tmpl
@@ -1,15 +1,10 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "gcore_lbmember Resource - terraform-provider-gcore"
+page_title: "{{ .Name }} {{ .Type }} - {{ .ProviderName	}}"
 subcategory: ""
 description: |-
-  Represent load balancer member
+  {{ .Description }}
 ---
 
-{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates.
-
-For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}}
-
 # {{ .Name }} ({{ .Type }})
 
 {{ .Description }}

diff --git a/templates/resources/lbpool.md.tmpl b/templates/resources/lbpool.md.tmpl
@@ -1,15 +1,10 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "gcore_lbpool Resource - terraform-provider-gcore"
+page_title: "{{ .Name }} {{ .Type }} - {{ .ProviderName	}}"
 subcategory: ""
 description: |-
-  Represent load balancer listener pool. A pool is a list of virtual machines to which the listener will redirect incoming traffic
+  {{ .Description }}
 ---
 
-{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates.
-
-For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}}
-
 # {{ .Name }} ({{ .Type }})
 
 {{ .Description }}

diff --git a/templates/resources/loadbalancerv2.md.tmpl b/templates/resources/loadbalancerv2.md.tmpl
@@ -1,15 +1,10 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "gcore_loadbalancerv2 Resource - terraform-provider-gcore"
+page_title: "{{ .Name }} {{ .Type }} - {{ .ProviderName	}}"
 subcategory: ""
 description: |-
-  Represent load balancer without nested listener
+  {{ .Description }}
 ---
 
-{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates.
-
-For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}}
-
 # {{ .Name }} ({{ .Type }})
 
 {{ .Description }}

diff --git a/templates/resources/subnet.md.tmpl b/templates/resources/subnet.md.tmpl
@@ -1,15 +1,10 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "gcore_subnet Resource - terraform-provider-gcore"
+page_title: "{{ .Name }} {{ .Type }} - {{ .ProviderName	}}"
 subcategory: ""
 description: |-
-  Represent subnets. Subnetwork is a range of IP addresses in a cloud network. Addresses from this range will be assigned to machines in the cloud
+  {{ .Description }}
 ---
 
-{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates.
-
-For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}}
-
 # {{ .Name }} ({{ .Type }})
 
 {{ .Description }}