Skip to content

Commit

Permalink
Update document description (#52)
Browse files Browse the repository at this point in the history
Signed-off-by: xueqingz <[email protected]>
  • Loading branch information
xueqingz authored Aug 8, 2024
1 parent a96a8a1 commit 61335d2
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion xenserver/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -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." + "<br />" +
Expand Down

0 comments on commit 61335d2

Please sign in to comment.