From 213c3d6df538706a58f3e2b23b039d79098adcc5 Mon Sep 17 00:00:00 2001 From: Vishal Perla Date: Thu, 4 Sep 2025 13:07:51 -0700 Subject: [PATCH] docs: fix typos and clarify wording in community docs (#3023) (cherry picked from commit a6e9ce42e4d4ca642965018160352b38fb2e0286) --- CONTRIBUTING.md | 2 +- examples/DOCUMENTATION.yml | 2 +- examples/README.md | 4 +--- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 75c8f4cf037..830da0a8097 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ contribution. See the [DCO](DCO) file for details. This repository has `stable-.` branches to correspond to each ansible-core major release. -ansible-documentation commmitters can add `backport-.` labels to +ansible-documentation committers can add `backport-.` labels to pull requests so the [Patchback bot] will automatically create backport pull requests after the original PR is merged. Small fixes or cleanups should at least be backported to the latest diff --git a/examples/DOCUMENTATION.yml b/examples/DOCUMENTATION.yml index b6ccb866298..9c4a9d870a5 100644 --- a/examples/DOCUMENTATION.yml +++ b/examples/DOCUMENTATION.yml @@ -17,7 +17,7 @@ options: option_name: description: - Description of the options goes here. - - Must be written in sentences. + - Each description should be a full sentence for clarity. required: true or false default: a string or the word null choices: diff --git a/examples/README.md b/examples/README.md index 307066dd8af..f13047ba680 100644 --- a/examples/README.md +++ b/examples/README.md @@ -6,9 +6,7 @@ This is to notify users that the aforementioned script is currently unmaintained ### Why Unmaintained ? The script is designed to check the current WinRM (PS Remoting) configuration and make the necessary changes to allow Ansible to connect, authenticate and execute PowerShell commands. As of now, Ansible can connect to Windows host that has already run `Enable-PSRemoting` in PowerShell already. -There's really no need to use this script at all as the defaults in Windows are just fine. Also, using the scripts may result in potential security issues. - - +There is no longer a need to use this script, as Windows defaults are sufficient. Also, using the scripts may result in potential security issues. ### Use at Your Own Risk - The script is provided as-is, without ongoing support or updates.