docs: add note callout for provider behaviour

d-strobel · Oct 18, 2024 · 545519d · 545519d
1 parent d12d407
commit 545519d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 7 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -9,9 +9,7 @@ description: |-
 <!-- provider description generated from schema -->
 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.
 
 <!-- examples generated from template and example files -->
 ## Example Usage

diff --git a/internal/generate/provider_windows/windows_provider_gen.go b/internal/generate/provider_windows/windows_provider_gen.go
diff --git 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",