diff --git a/docs/index.md b/docs/index.md index 129a62f..5f35c05 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,12 +3,16 @@ page_title: "pinecone Provider" subcategory: "" description: |- - + You can use the this Terraform provider to manage resources supported + by Pinecone https://www.pinecone.io/. The provider must be configured with the proper + credentials before use. You can provide credentials via the PINECONEAPIKEY environment variable. --- # pinecone Provider - +You can use the this Terraform provider to manage resources supported +by [Pinecone](https://www.pinecone.io/). The provider must be configured with the proper +credentials before use. You can provide credentials via the PINECONE_API_KEY environment variable. ## Example Usage diff --git a/docs/resources/collection.md b/docs/resources/collection.md index aa94d66..0a5913e 100644 --- a/docs/resources/collection.md +++ b/docs/resources/collection.md @@ -3,12 +3,12 @@ page_title: "pinecone_collection Resource - terraform-provider-pinecone" subcategory: "" description: |- - Collection resource + The pinecone_collection resource lets you create and manage collections in Pinecone. Learn more about collections in the docs hhttps://docs.pinecone.io/guides/indexes/understanding-collections. --- # pinecone_collection (Resource) -Collection resource +The `pinecone_collection` resource lets you create and manage collections in Pinecone. Learn more about collections in the [docs](hhttps://docs.pinecone.io/guides/indexes/understanding-collections). ## Example Usage diff --git a/docs/resources/index.md b/docs/resources/index.md index be70cde..2a73e60 100644 --- a/docs/resources/index.md +++ b/docs/resources/index.md @@ -3,12 +3,12 @@ page_title: "pinecone_index Resource - terraform-provider-pinecone" subcategory: "" description: |- - Index resource + The pinecone_index resource lets you create and manage indexes in Pinecone. Learn more about indexes in the docs https://docs.pinecone.io/guides/indexes/understanding-indexes. --- # pinecone_index (Resource) -Index resource +The `pinecone_index` resource lets you create and manage indexes in Pinecone. Learn more about indexes in the [docs](https://docs.pinecone.io/guides/indexes/understanding-indexes). ## Example Usage diff --git a/pinecone/provider/collection_resource.go b/pinecone/provider/collection_resource.go index 0d5f37a..b936df6 100644 --- a/pinecone/provider/collection_resource.go +++ b/pinecone/provider/collection_resource.go @@ -43,7 +43,7 @@ func (r *CollectionResource) Metadata(ctx context.Context, req resource.Metadata func (r *CollectionResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "Collection resource", + MarkdownDescription: "The `pinecone_collection` resource lets you create and manage collections in Pinecone. Learn more about collections in the [docs](hhttps://docs.pinecone.io/guides/indexes/understanding-collections).", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ MarkdownDescription: "Collection identifier", diff --git a/pinecone/provider/index_resource.go b/pinecone/provider/index_resource.go index 38111cc..8558292 100644 --- a/pinecone/provider/index_resource.go +++ b/pinecone/provider/index_resource.go @@ -54,7 +54,7 @@ func (r *IndexResource) Metadata(ctx context.Context, req resource.MetadataReque func (r *IndexResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ // This description is used by the documentation generator and the language server. - MarkdownDescription: "Index resource", + MarkdownDescription: "The `pinecone_index` resource lets you create and manage indexes in Pinecone. Learn more about indexes in the [docs](https://docs.pinecone.io/guides/indexes/understanding-indexes).", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ diff --git a/pinecone/provider/provider.go b/pinecone/provider/provider.go index c95314b..6264741 100644 --- a/pinecone/provider/provider.go +++ b/pinecone/provider/provider.go @@ -32,12 +32,17 @@ type PineconeProviderModel struct { } func (p *PineconeProvider) Metadata(ctx context.Context, req provider.MetadataRequest, resp *provider.MetadataResponse) { + resp.TypeName = "pinecone" resp.Version = p.version } func (p *PineconeProvider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse) { resp.Schema = schema.Schema{ + MarkdownDescription: `You can use the this Terraform provider to manage resources supported +by [Pinecone](https://www.pinecone.io/). The provider must be configured with the proper +credentials before use. You can provide credentials via the PINECONE_API_KEY environment variable.`, + Attributes: map[string]schema.Attribute{ "api_key": schema.StringAttribute{ MarkdownDescription: "Pinecone API Key. Can be configured by setting PINECONE_API_KEY environment variable.",