Skip to content

Commit a6e9ce4

Browse files
authored
docs: fix typos and clarify wording in community docs (#3023)
1 parent fac47a3 commit a6e9ce4

File tree

3 files changed

+3
-5
lines changed

3 files changed

+3
-5
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ contribution. See the [DCO](DCO) file for details.
1414

1515
This repository has `stable-<MAJOR>.<MINOR>` branches to correspond to each
1616
ansible-core major release.
17-
ansible-documentation commmitters can add `backport-<MAJOR>.<MINOR>` labels to
17+
ansible-documentation committers can add `backport-<MAJOR>.<MINOR>` labels to
1818
pull requests so the [Patchback bot] will automatically create backport pull
1919
requests after the original PR is merged.
2020
Small fixes or cleanups should at least be backported to the latest

examples/DOCUMENTATION.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ options:
1717
option_name:
1818
description:
1919
- Description of the options goes here.
20-
- Must be written in sentences.
20+
- Each description should be a full sentence for clarity.
2121
required: true or false
2222
default: a string or the word null
2323
choices:

examples/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ This is to notify users that the aforementioned script is currently unmaintained
66
### Why Unmaintained ?
77
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.
88

9-
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.
10-
11-
9+
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.
1210

1311
### Use at Your Own Risk
1412
- The script is provided as-is, without ongoing support or updates.

0 commit comments

Comments
 (0)