From 286938c2664e64eeb7706fd82b8812340a159e9c Mon Sep 17 00:00:00 2001 From: Dustin Strobel Date: Fri, 18 Oct 2024 17:10:40 +0200 Subject: [PATCH] docs: add note callout for provider behaviour --- docs/index.md | 4 +--- internal/generate/provider_windows/windows_provider_gen.go | 4 ++-- internal/schema/provider_windows.json | 4 ++-- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/index.md b/docs/index.md index d1f1e93..6eb25d8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,9 +9,7 @@ description: |- The windows provider is used to interact remotely via winrm or ssh with a windows system. -**Important**: -Due to the limitations of the terraform-plugin-framework some attributes are listed as optionals even though a combination of certain parameters are required. -Check examples below for reference. +~> **Important** Due to the limitations of the terraform-plugin-framework some attributes are listed as optionals even though a combination of certain parameters are required. Check examples below for reference. ## Example Usage diff --git a/internal/generate/provider_windows/windows_provider_gen.go b/internal/generate/provider_windows/windows_provider_gen.go index 91eb051..5d18e1c 100644 --- a/internal/generate/provider_windows/windows_provider_gen.go +++ b/internal/generate/provider_windows/windows_provider_gen.go @@ -116,8 +116,8 @@ func WindowsProviderSchema(ctx context.Context) schema.Schema { MarkdownDescription: "Define the WinRM connection parameters. Exactly one of 'winrm' or 'ssh' must be set for the provider to connect to a Windows target system. Define an empty 'winrm' attribute if you wish to use the environment variables.", }, }, - Description: "The windows provider is used to interact remotely via winrm or ssh with a windows system.\n\n**Important**:\nDue to the limitations of the terraform-plugin-framework some attributes are listed as optionals even though a combination of certain parameters are required\nCheck examples below for reference.", - MarkdownDescription: "The windows provider is used to interact remotely via winrm or ssh with a windows system.\n\n**Important**:\nDue to the limitations of the terraform-plugin-framework some attributes are listed as optionals even though a combination of certain parameters are required.\nCheck examples below for reference.", + Description: "The windows provider is used to interact remotely via winrm or ssh with a windows system.\n\n~> **Important** Due to the limitations of the terraform-plugin-framework some attributes are listed as optionals even though a combination of certain parameters are required. Check examples below for reference.", + MarkdownDescription: "The windows provider is used to interact remotely via winrm or ssh with a windows system.\n\n~> **Important** Due to the limitations of the terraform-plugin-framework some attributes are listed as optionals even though a combination of certain parameters are required. Check examples below for reference.", } } diff --git a/internal/schema/provider_windows.json b/internal/schema/provider_windows.json index a075006..9345f99 100644 --- a/internal/schema/provider_windows.json +++ b/internal/schema/provider_windows.json @@ -3,8 +3,8 @@ "provider": { "name": "windows", "schema": { - "description": "The windows provider is used to interact remotely via winrm or ssh with a windows system.\n\n**Important**:\nDue to the limitations of the terraform-plugin-framework some attributes are listed as optionals even though a combination of certain parameters are required\nCheck examples below for reference.", - "markdown_description": "The windows provider is used to interact remotely via winrm or ssh with a windows system.\n\n**Important**:\nDue to the limitations of the terraform-plugin-framework some attributes are listed as optionals even though a combination of certain parameters are required.\nCheck examples below for reference.", + "description": "The windows provider is used to interact remotely via winrm or ssh with a windows system.\n\n~> **Important** Due to the limitations of the terraform-plugin-framework some attributes are listed as optionals even though a combination of certain parameters are required. Check examples below for reference.", + "markdown_description": "The windows provider is used to interact remotely via winrm or ssh with a windows system.\n\n~> **Important** Due to the limitations of the terraform-plugin-framework some attributes are listed as optionals even though a combination of certain parameters are required. Check examples below for reference.", "attributes": [ { "name": "endpoint",