From 61335d29c9e62f2fc0f87efac59d1ae57f9f16c3 Mon Sep 17 00:00:00 2001 From: xueqingz <52194917+xueqingz@users.noreply.github.com> Date: Thu, 8 Aug 2024 09:38:55 +0800 Subject: [PATCH] Update document description (#52) Signed-off-by: xueqingz --- README.md | 5 ++--- docs/index.md | 4 ++-- xenserver/provider.go | 2 +- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b1a97d7..6371789 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Terraform Provider XenServer - -This repository the terraform provider of XenServer, using the Terraform Plugin Framework(https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework), containing: +This repository is the [Terraform Provider of XenServer](https://registry.terraform.io/providers/xenserver/xenserver/latest/docs), using the [Terraform Plugin Framework](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework), containing: - `docs/` The generated documentation. - `examples/` The examples of provider, resources and data sources. @@ -37,7 +36,7 @@ To compile the provider, run `"go install"`. This will build the provider and pu ### Document -To generate or update documentation, run `go generate ./...`. +To generate or update documentation, run `make doc`. ### Log diff --git a/docs/index.md b/docs/index.md index 708809f..bb5b010 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,12 +2,12 @@ page_title: "XenServer Provider" subcategory: "" description: |- - The XenServer provider can be used to manage and deploy XenServer resources. You must configure the provider with the proper credentials before you can use it. Documentation regarding the Data Sources and Resources supported by the XenServer Provider can be found in the navigation to the left. Note that this provider is still in development. + The XenServer provider can be used to manage and deploy XenServer resources. Before using it, you must configure the provider with the appropriate credentials. Documentation regarding the data sources and resources supported by the XenServer provider can be found in the navigation on the left. --- # XenServer Provider -The XenServer provider can be used to manage and deploy XenServer resources. You must configure the provider with the proper credentials before you can use it. Documentation regarding the Data Sources and Resources supported by the XenServer Provider can be found in the navigation to the left. Note that this provider is still in development. +The XenServer provider can be used to manage and deploy XenServer resources. Before using it, you must configure the provider with the appropriate credentials. Documentation regarding the data sources and resources supported by the XenServer provider can be found in the navigation on the left. ## Example Usage diff --git a/xenserver/provider.go b/xenserver/provider.go index 9af2c8d..0cd5da3 100644 --- a/xenserver/provider.go +++ b/xenserver/provider.go @@ -50,7 +50,7 @@ func (p *xsProvider) Metadata(_ context.Context, _ provider.MetadataRequest, res func (p *xsProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "The XenServer provider can be used to manage and deploy XenServer resources. You must configure the provider with the proper credentials before you can use it. Documentation regarding the Data Sources and Resources supported by the XenServer Provider can be found in the navigation to the left. Note that this provider is still in development.", + MarkdownDescription: "The XenServer provider can be used to manage and deploy XenServer resources. Before using it, you must configure the provider with the appropriate credentials. Documentation regarding the data sources and resources supported by the XenServer provider can be found in the navigation on the left.", Attributes: map[string]schema.Attribute{ "host": schema.StringAttribute{ MarkdownDescription: "The base URL of target XenServer host." + "
" +