From 6f0852d2c9931b1bf55f975c0ec4be5020e7b3cf Mon Sep 17 00:00:00 2001 From: 1riatsila1 Date: Wed, 4 Dec 2024 15:32:34 +0200 Subject: [PATCH] Link some provider docs --- INSTALL.md | 2 +- docs/index.md | 3 +++ internal/provider/provider.go | 4 +++- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 2a95435a..24a302ce 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -72,7 +72,7 @@ The following example uses Zsh (default) on macOS (Apple Silicon). ```console RELEASE=x.y.z - wget -q https://github.com/aruba-uxi/terraform-provider-hpeuxi/releases/download/v${RELEASE}/terraform-provider-hpeuxi_${RELEASE}_darwin_arm64.zip + wget https://github.com/aruba-uxi/terraform-provider-hpeuxi/releases/download/v${RELEASE}/terraform-provider-hpeuxi_${RELEASE}_darwin_arm64.zip ``` 3. Extract the plugin. diff --git a/docs/index.md b/docs/index.md index 6da79f03..d2bf4639 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,12 +3,15 @@ page_title: "hpeuxi Provider" description: |- Interact with HPE Aruba Network UXI Configuration. + See https://developer.greenlake.hpe.com/docs/greenlake/guides/public/authentication/authentication/#configuring-api-client-credentials for more information on generating client credentials. --- # hpeuxi Provider Interact with HPE Aruba Network UXI Configuration. +See https://developer.greenlake.hpe.com/docs/greenlake/guides/public/authentication/authentication/#configuring-api-client-credentials for more information on generating client credentials. + ## Example Usage ```terraform diff --git a/internal/provider/provider.go b/internal/provider/provider.go index 913722cf..de1096ee 100644 --- a/internal/provider/provider.go +++ b/internal/provider/provider.go @@ -60,7 +60,9 @@ func (p *hpeuxiConfigurationProvider) Schema( resp *provider.SchemaResponse, ) { resp.Schema = schema.Schema{ - Description: "Interact with HPE Aruba Network UXI Configuration.", + Description: "Interact with HPE Aruba Network UXI Configuration." + + "\n\nSee https://developer.greenlake.hpe.com/docs/greenlake/guides/public/authentication/authentication/#configuring-api-client-credentials " + + "for more information on generating client credentials.", Attributes: map[string]schema.Attribute{ "client_id": schema.StringAttribute{ Description: "The Client ID as obtained from HPE GreenLake API client credentials. " +