docs: Fix spelling issues + fix reported issues (#274)

* README: Fix double-the in documentation

* README: Consistently referer to the role name and not to repository name

* README: Improve wording

* Fix more typos

* ci: Add GH action to check for spelling mistakes
This commit is contained in:
Jakub Jelen 2024-01-29 18:55:43 +01:00 committed by GitHub
parent 0dd0868627
commit d48e898148
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 28 additions and 10 deletions

18
.github/workflows/codespell.yml vendored Normal file
View file

@ -0,0 +1,18 @@
---
name: Codespell
on:
pull_request:
push:
permissions:
contents: read # to fetch code (actions/checkout)
jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: codespell-project/actions-codespell@master

View file

@ -90,7 +90,7 @@ for AIX)
#### sshd_allow_reload
If set to *false*, a reload of sshd wont happen on change. This can help with
If set to *false*, a reload of sshd won't happen on change. This can help with
troubleshooting. You'll need to manually reload sshd if you want to apply the
changed configuration. Defaults to the same value as `sshd_manage_service`.
(Except on AIX, where `sshd_manage_service` is default *false*, but
@ -113,7 +113,7 @@ the `sshd_service` variable.
#### sshd_manage_firewall
If set to *true*, the the SSH port(s) will be opened in firewall. Note, this
If set to *true*, the SSH port(s) will be opened in firewall. Note, this
works only on Red Hat based OS. The default is *false*.
NOTE: `sshd_manage_firewall` is limited to *adding* ports. It cannot be used
@ -122,7 +122,7 @@ firewall system role directly.
#### sshd_manage_selinux
If set to *true*, the the selinux will be configured to allow sshd listening
If set to *true*, the selinux will be configured to allow sshd listening
on the given SSH port(s). Note, this works only on Red Hat based OS.
The default is *false*.
@ -233,8 +233,8 @@ non-conflicting options from different roles invocations.
#### sshd_config_owner, sshd_config_group, sshd_config_mode
Use these variables to set the ownership and permissions for the openssh config
file that this role produces.
Use these variables to set the ownership and permissions for the openssh
configuration file that this role produces.
#### sshd_verify_hostkeys
@ -424,7 +424,7 @@ option:
tasks:
- name: Configure sshd to accept some useful environment variables
include_role:
name: ansible-sshd
name: willshersystems.sshd
vars:
sshd_config_namespace: accept-env
sshd:
@ -451,7 +451,7 @@ More example playbooks can be found in [`examples/`](examples/) directory.
The [`sshd_config.j2`](templates/sshd_config.j2) and
[`sshd_config_snippet.j2`](templates/sshd_config_snippet.j2) templates are
programatically generated by the scripts in meta. New options should be added
programmatically generated by the scripts in meta. New options should be added
to the `options_body` and/or `options_match`.
To regenerate the templates, from within the `meta/` directory run:

View file

@ -47,7 +47,7 @@ You must use automation to create releases consistently. The process of creating
This script creates updates CHANGELOG.md with a summary of pull requests added since the previous release and with automatically identified new version based on the PR types.
It also optionally updates .README.html with changes to README.md made since the previous release.
To learn more about available script options, see [role-make-version-changelog.sh documantation](https://github.com/linux-system-roles/auto-maintenance#role-make-version-changelogsh).
To learn more about available script options, see [role-make-version-changelog.sh documentation](https://github.com/linux-system-roles/auto-maintenance#role-make-version-changelogsh).
4. Verify that the script added a commit for new release by running `git log`.

View file

@ -21,7 +21,7 @@
vars:
sshd_install_service: true
- name: Verify the runtime diretory is created on Debian
- name: Verify the runtime directory is created on Debian
tags: tests::verify
when:
- ansible_facts['os_family'] == "Debian"
@ -96,7 +96,7 @@
- '"RuntimeDirectory=" not in service_inst.content | b64decode'
- '"RuntimeDirectoryMode=" not in service_inst.content | b64decode'
- name: Verify the runtime diretory is not created in wrong places
- name: Verify the runtime directory is not created in wrong places
tags: tests::verify
block:
- name: Stat the home directory for the runtime directory