Update documentation / minor cosmetic code change (#10)

gmichels · Mar 8, 2023 · 4e83339 · 4e83339
1 parent ec159a5
commit 4e83339
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,16 @@
 # AdGuard Home Terraform Provider (terraform-provider-adguard)
 
-**WARNING** under development
+[![Release](https://img.shields.io/github/v/release/gmichels/terraform-provider-adguard)](https://github.com/gmichels/terraform-provider-adguard/releases)
+[![Installs](https://img.shields.io/badge/dynamic/json?logo=terraform&label=installs&query=$.data.attributes.downloads&url=https%3A%2F%2Fregistry.terraform.io%2Fv2%2Fproviders%2F713)](https://registry.terraform.io/providers/gmichels/adguard)
+[![Registry](https://img.shields.io/badge/registry-doc%40latest-lightgrey?logo=terraform)](https://registry.terraform.io/providers/gmichels/adguard/latest/docs)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/gmichels/terraform-provider-adguard/blob/main/LICENSE)
+[![Status](https://github.com/gmichels/terraform-provider-adguard/workflows/Release/badge.svg)](https://github.com/gmichels/terraform-provider-adguard/actions)
+[![Go Report Card](https://goreportcard.com/badge/github.com/gmichels/terraform-provider-adguard)](https://goreportcard.com/report/github.com/gmichels/terraform-provider-adguard)
+
+The AdGuard provider provides resources to interact with an [AdGuard Home](https://github.com/AdguardTeam/AdGuardHome) server.
 
 Functionality first needs to be added to the [adguard-client-go](https://github.com/gmichels/adguard-client-go) SDK.
 
 # Documentation
 
-You can browse documentation under the [docs](docs) folder.
+You can browse documentation and examples on the [Terraform provider registry](https://registry.terraform.io/providers/gmichels/adguard/latest/docs).
diff --git a/adguard/client_resource.go b/adguard/client_resource.go
@@ -182,45 +182,45 @@ func (r *clientResource) Create(ctx context.Context, req resource.CreateRequest,
 	}
 
 	// instantiate empty client for storing plan data
-	var clientPlan adguard.Client
+	var client adguard.Client
 
 	// populate client from plan
-	clientPlan.Name = plan.Name.ValueString()
-	diags = plan.Ids.ElementsAs(ctx, &clientPlan.Ids, false)
+	client.Name = plan.Name.ValueString()
+	diags = plan.Ids.ElementsAs(ctx, &client.Ids, false)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
 		return
 	}
-	clientPlan.UseGlobalSettings = plan.UseGlobalSettings.ValueBool()
-	clientPlan.FilteringEnabled = plan.FilteringEnabled.ValueBool()
-	clientPlan.ParentalEnabled = plan.ParentalEnabled.ValueBool()
-	clientPlan.SafebrowsingEnabled = plan.SafebrowsingEnabled.ValueBool()
-	clientPlan.SafesearchEnabled = plan.SafesearchEnabled.ValueBool()
-	clientPlan.UseGlobalBlockedServices = plan.UseGlobalBlockedServices.ValueBool()
+	client.UseGlobalSettings = plan.UseGlobalSettings.ValueBool()
+	client.FilteringEnabled = plan.FilteringEnabled.ValueBool()
+	client.ParentalEnabled = plan.ParentalEnabled.ValueBool()
+	client.SafebrowsingEnabled = plan.SafebrowsingEnabled.ValueBool()
+	client.SafesearchEnabled = plan.SafesearchEnabled.ValueBool()
+	client.UseGlobalBlockedServices = plan.UseGlobalBlockedServices.ValueBool()
 	if len(plan.BlockedServices.Elements()) > 0 {
-		diags = plan.BlockedServices.ElementsAs(ctx, &clientPlan.BlockedServices, false)
+		diags = plan.BlockedServices.ElementsAs(ctx, &client.BlockedServices, false)
 		resp.Diagnostics.Append(diags...)
 		if resp.Diagnostics.HasError() {
 			return
 		}
 	}
 	if len(plan.Upstreams.Elements()) > 0 {
-		diags = plan.Upstreams.ElementsAs(ctx, &clientPlan.Upstreams, false)
+		diags = plan.Upstreams.ElementsAs(ctx, &client.Upstreams, false)
 		resp.Diagnostics.Append(diags...)
 		if resp.Diagnostics.HasError() {
 			return
 		}
 	}
 	if len(plan.Tags.Elements()) > 0 {
-		diags = plan.Tags.ElementsAs(ctx, &clientPlan.Tags, false)
+		diags = plan.Tags.ElementsAs(ctx, &client.Tags, false)
 		resp.Diagnostics.Append(diags...)
 		if resp.Diagnostics.HasError() {
 			return
 		}
 	}
 
 	// create new clientState using plan
-	clientState, err := r.adg.CreateClient(clientPlan)
+	clientState, err := r.adg.CreateClient(client)
 	if err != nil {
 		resp.Diagnostics.AddError(
 			"Error creating client",

diff --git a/adguard/provider.go b/adguard/provider.go
@@ -43,6 +43,7 @@ func (p *adguardProvider) Metadata(_ context.Context, _ provider.MetadataRequest
 // Schema defines the provider-level schema for configuration data
 func (p *adguardProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse) {
 	resp.Schema = schema.Schema{
+		Description: "The AdGuard provider provides resources to interact with an [AdGuard Home](https://github.com/AdguardTeam/AdGuardHome) server",
 		Attributes: map[string]schema.Attribute{
 			"host": schema.StringAttribute{
 				Description: "The hostname of the AdGuard Home instance. Include the port if not on a standard HTTP/HTTPS port",

diff --git a/docs/index.md b/docs/index.md
@@ -3,12 +3,12 @@
 page_title: "adguard Provider"
 subcategory: ""
 description: |-
-  
+  The AdGuard provider provides resources to interact with an AdGuard Home https://github.com/AdguardTeam/AdGuardHome server
 ---
 
 # adguard Provider
 
-
+The AdGuard provider provides resources to interact with an [AdGuard Home](https://github.com/AdguardTeam/AdGuardHome) server
 
 ## Example Usage