docs: proposed changes to the documentation

docs/data-sources/local_group.md

@@ -8,7 +8,7 @@ description: |-
 
 <!-- data-source description generated from schema -->
 Retrieve information about a local security group.
-You can get a group by the name or the security ID of the group.
+You can retrieve a group by its name or security ID.
 <!-- examples generated from example files -->
 ## Example Usage
 
@@ -23,8 +23,10 @@ data "windows_local_group" "Administrator" {
 
 ### Optional
 
-- `name` (String) The name of the local security group. Exactly one of 'name' or 'sid' is required.
-- `sid` (String) The security ID of the local security group. Exactly one of 'name' or 'sid' is required.
+~> **Important** Exactly one of 'name' or 'sid' is required.
+
+- `name` (String) The name of the local security group.
+- `sid` (String) The security ID of the local security group.
 
 ### Read-Only
 

docs/data-sources/local_group_members.md

@@ -2,12 +2,12 @@
 page_title: "windows_local_group_members Data Source - terraform-provider-windows"
 subcategory: "Local"
 description: |-
-  Retrieve a list of members for a specific local security group
+  Retrieve a list of members of a specific local security group
 ---
 # windows_local_group_members (Data Source)
 
 <!-- data-source description generated from schema -->
-Retrieve a list of members for a specific local security group.
+Retrieve a list of members of a specific local security group.
 <!-- examples generated from example files -->
 ## Example Usage
 

docs/data-sources/local_user.md

@@ -7,7 +7,7 @@ description: |-
 # windows_local_user (Data Source)
 
 <!-- data-source description generated from schema -->
-Retrieve information about a local user. You can get a user by the name or the security ID.
+Retrieve information about a local user. You can retrieve a user by its name or security ID.
 <!-- examples generated from example files -->
 ## Example Usage
 
@@ -22,8 +22,10 @@ data "windows_local_user" "admin" {
 
 ### Optional
 
-- `name` (String) The name of the local user. Exactly one of 'name' or 'sid' is required.
-- `sid` (String) The security ID of the local user. Exactly one of 'name' or 'sid' is required.
+~> **Important** Exactly one of 'name' or 'sid' is required.
+
+- `name` (String) The name of the local user.
+- `sid` (String) The security ID of the local user.
 
 ### Read-Only
 

docs/index.md

@@ -72,8 +72,10 @@ EOT
 
 ### Optional
 
-- `ssh` (Attributes) Define the SSH connection parameters. Exactly one of 'winrm' or 'ssh' must be set for the provider to connect to a Windows target system. Define an empty 'ssh' attribute if you wish to use the environment variables. (see [below for nested schema](#nestedatt--ssh))
-- `winrm` (Attributes) 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. (see [below for nested schema](#nestedatt--winrm))
+~> **Important** Exactly one of 'winrm' or 'ssh' must be set for the provider to connect to a Windows target system.
+
+- `ssh` (Attributes) Define the SSH connection parameters. Define an empty 'ssh' attribute if you wish to use the environment variables. (see [below for nested schema](#nestedatt--ssh))
+- `winrm` (Attributes) Define the WinRM connection parameters. Define an empty 'winrm' attribute if you wish to use the environment variables. (see [below for nested schema](#nestedatt--winrm))
 
 <a id="nestedatt--ssh"></a>
 ### Nested Schema for `ssh`
@@ -82,11 +84,11 @@ Optional:
 
 - `insecure` (Boolean) (Env: `WIN_SSH_INSECURE`) (Default: `false`)<br>Accept insecure SSH connections. This includes e.g. the acceptance of unknown or changed host keys.
 - `known_hosts_path` (String) (Env: `WIN_SSH_KNOWN_HOSTS_PATH`)<br>Define the path to the known hosts file to connect with the target Windows system.
+- `username` (String) (Env: `WIN_SSH_USERNAME`)<br>Define the username to connect with the target Windows system. Required if ssh is set.
 - `password` (String, Sensitive) (Env: `WIN_SSH_PASSWORD`)<br>Define the password to connect with the target Windows system. Exactly one of 'password', 'private_key' or 'private_key_path' is required if ssh is set.
 - `port` (Number) (Env: `WIN_SSH_PORT`) (Default: `22`)<br>Define the port to connect with the target Windows system.
 - `private_key` (String, Sensitive) (Env: `WIN_SSH_PRIVATE_KEY`)<br>Define the private key to connect with the target Windows system. Exactly one of 'password', 'private_key' or 'private_key_path' is required if ssh is set.
 - `private_key_path` (String) (Env: `WIN_SSH_PRIVATE_KEY_PATH`)<br>Define the path to the private key file to connect with the target Windows system. Exactly one of 'password', 'private_key' or 'private_key_path' is required if ssh is set.
-- `username` (String) (Env: `WIN_SSH_USERNAME`)<br>Define the username to connect with the target Windows system. Required if ssh is set.
 
 
 <a id="nestedatt--winrm"></a>
@@ -95,11 +97,8 @@ Optional:
 Optional:
 
 - `insecure` (Boolean) (Env: `WIN_WINRM_INSECURE`) (Default: `false`)<br>Accept insecure WinRM connection. This includes e.g. the acceptance of untrusted certificates.
+- `username` (String) (Env: `WIN_WINRM_USERNAME`)<br>Define the username to connect with the target Windows system. Required if winrm is set.
 - `password` (String, Sensitive) (Env: `WIN_WINRM_PASSWORD`)<br>Define the password to connect with the target Windows system. Required if winrm is set.
 - `port` (Number) (Env: `WIN_WINRM_PORT`) (Default: `5986`)<br>Define the port to connect with the target Windows system.
 - `timeout` (Number) (Env: `WIN_WINRM_TIMEOUT`) (Default: `0`)<br>Define the connection timeout in minutes for the target Windows system.
 - `use_tls` (Boolean) (Env: `WIN_WINRM_USE_TLS`) (Default: `true`)<br>Define if TLS (https) should be used to connect with the target Windows system.
-- `username` (String) (Env: `WIN_WINRM_USERNAME`)<br>Define the username to connect with the target Windows system. Required if winrm is set.
-
-
-

docs/resources/local_group.md

@@ -25,7 +25,7 @@ resource "windows_local_group" "test" {
 
 ### Required
 
-- `name` (String) Define the name for the local security group. The maximum length is 256 characters.
+- `name` (String) Define the name for the local security group. The maximum length is 256 characters. A local security name can't contain the following characters: `"`, `/`, `\`, `[`, `]`, `:`, `;`, `|`, `=`, `,`, `+`, `*`, `?`, `<`, `>`, `@`
 
 ### Optional
 

docs/resources/local_group_member.md

@@ -2,12 +2,12 @@
 page_title: "windows_local_group_member Resource - terraform-provider-windows"
 subcategory: "Local"
 description: |-
-  Manage group member for local security groups
+  Manage members of local security groups
 ---
 # windows_local_group_member (Resource)
 
 <!-- resource description generated from schema -->
-Manage group member for local security groups.
+Manage members of local security groups.
 <!-- examples generated from example files -->
 ## Example Usage
 

docs/resources/local_user.md

@@ -33,7 +33,7 @@ resource "windows_local_user" "this" {
 
 ### Optional
 
-- `account_expires` (String) Define when the local user account expires. If not specified, the user account never expires.<br>The string time format is the following: `2023-07-25T20:43:16Z` (see [Terraform timetypes](https://pkg.go.dev/github.com/hashicorp/[email protected]/timetypes#RFC3339)).
+- `account_expires` (String) Define when the local user account expires. If not specified, the user account never expires.<br>The string time format is the following: `2023-07-25T20:43:16Z` (ISO 8601 datetime/RFC3389, see [Terraform timetypes](https://pkg.go.dev/github.com/hashicorp/[email protected]/timetypes#RFC3339)).
 - `description` (String) Define a description for the local user. The maximum length is 48 characters.
 - `enabled` (Boolean) (Default: `true`)<br>Define whether the local user is enabled.
 - `full_name` (String) Define the full name of the local user. The full name differs from the user name of the user account.