Improve generated docs

ffddorf · Jul 20, 2024 · f561eeb · f561eeb
1 parent d300ee8
commit f561eeb
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 9 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -3,18 +3,22 @@
 page_title: "netboxbgp Provider"
 subcategory: ""
 description: |-
-  
+  This provider allows managing BGP resources in Netbox, when the Netbox BGP plugin https://github.com/netbox-community/netbox-bgp is installed.
+  The provider is intentionally using a similar structure to the e-breuninger/netbox https://registry.terraform.io/providers/e-breuninger/netbox/latest provider. If you're already using that provider, this provider should work smoothly alongside it.
 ---
 
 # netboxbgp Provider
 
+This provider allows managing BGP resources in Netbox, when the [Netbox BGP plugin](https://github.com/netbox-community/netbox-bgp) is installed.
 
+The provider is intentionally using a similar structure to the [`e-breuninger/netbox`](https://registry.terraform.io/providers/e-breuninger/netbox/latest) provider. If you're already using that provider, this provider should work smoothly alongside it.
 
 ## Example Usage
 
 ```terraform
 provider "netboxbgp" {
-  # example configuration here
+  server_url = "https://netbox.my-company.net"
+  api_token  = var.netbox_api_token
 }
 ```
 

diff --git a/examples/data-sources/scaffolding_example/data-source.tf b/examples/data-sources/scaffolding_example/data-source.tf
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -1,3 +1,4 @@
 provider "netboxbgp" {
-  # example configuration here
+  server_url = "https://netbox.my-company.net"
+  api_token  = var.netbox_api_token
 }
diff --git a/examples/resources/scaffolding_example/resource.tf b/examples/resources/scaffolding_example/resource.tf
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -6,6 +6,7 @@ package provider
 import (
 	"context"
 	"crypto/tls"
+	_ "embed"
 	"net/http"
 
 	"github.com/ffddorf/terraform-provider-netbox-bgp/client"
@@ -20,6 +21,11 @@ import (
 // Ensure NetboxBGPProvider satisfies various provider interfaces.
 var _ provider.Provider = &NetboxBGPProvider{}
 
+var (
+	//go:embed provider.md
+	providerDocs string
+)
+
 // NetboxBGPProvider defines the provider implementation.
 type NetboxBGPProvider struct {
 	// version is set to the provider version on release, "dev" when the
@@ -51,6 +57,7 @@ func (p *NetboxBGPProvider) Metadata(ctx context.Context, req provider.MetadataR
 
 func (p *NetboxBGPProvider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse) {
 	resp.Schema = schema.Schema{
+		MarkdownDescription: providerDocs,
 		Attributes: map[string]schema.Attribute{
 			"server_url": schema.StringAttribute{
 				MarkdownDescription: "Location of Netbox server including scheme (http or https) and optional port. Can be set via the `NETBOX_SERVER_URL` environment variable.",

diff --git a/internal/provider/provider.md b/internal/provider/provider.md
@@ -0,0 +1,3 @@
+This provider allows managing BGP resources in Netbox, when the [Netbox BGP plugin](https://github.com/netbox-community/netbox-bgp) is installed.
+
+The provider is intentionally using a similar structure to the [`e-breuninger/netbox`](https://registry.terraform.io/providers/e-breuninger/netbox/latest) provider. If you're already using that provider, this provider should work smoothly alongside it.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		This provider allows managing BGP resources in Netbox, when the [Netbox BGP plugin](https://github.com/netbox-community/netbox-bgp) is installed.

		The provider is intentionally using a similar structure to the [`e-breuninger/netbox`](https://registry.terraform.io/providers/e-breuninger/netbox/latest) provider. If you're already using that provider, this provider should work smoothly alongside it.