From 0591b5f98c66507308bdeeace4e28edf95105c9f Mon Sep 17 00:00:00 2001 From: Don Naro Date: Thu, 27 Mar 2025 11:56:32 +0000 Subject: [PATCH] Fix codespell issues (#2478) * add entries to codespell ignored words list * fix spelling issues --- .codespellignorewords | 2 ++ docs/docsite/Makefile | 4 ++-- docs/docsite/rst/os_guide/windows_performance.rst | 2 +- docs/docsite/rst/playbook_guide/playbooks_reuse.rst | 10 +++++----- .../rst/playbook_guide/playbooks_startnstep.rst | 2 +- docs/docsite/rst/user_guide/playbooks_reuse.rst | 2 +- 6 files changed, 12 insertions(+), 10 deletions(-) diff --git a/.codespellignorewords b/.codespellignorewords index e59b06502e..801430d21b 100644 --- a/.codespellignorewords +++ b/.codespellignorewords @@ -2,3 +2,5 @@ aci falsy doas +lets +gotcha diff --git a/docs/docsite/Makefile b/docs/docsite/Makefile index 8fa6373fca..084db7f027 100644 --- a/docs/docsite/Makefile +++ b/docs/docsite/Makefile @@ -10,7 +10,7 @@ else CPUS ?= $(shell nproc) endif -# Intenationalisation and Localisation +# Intenationalisation and Localization LANGUAGES ?= # Sets the build output directory for the main docsite if it's not already specified @@ -58,7 +58,7 @@ generate_rst: collections_meta config cli keywords plugins core_generate_rst: collections_meta config cli keywords core_plugins # At the moment localizing the plugins and collections is not required for the ongoing -# localisation effort. It will come at a later time. +# localization effort. It will come at a later time. gettext_generate_rst: collections_meta config cli keywords # The following symlinks are necessary to produce two different docsets diff --git a/docs/docsite/rst/os_guide/windows_performance.rst b/docs/docsite/rst/os_guide/windows_performance.rst index 7adf5d8199..6c9f0ec589 100644 --- a/docs/docsite/rst/os_guide/windows_performance.rst +++ b/docs/docsite/rst/os_guide/windows_performance.rst @@ -71,7 +71,7 @@ PowerShell is used by every Windows Ansible module. This optimization reduces the time PowerShell takes to start up, removing that overhead from every invocation. This snippet uses `the native image generator, ngen `_ -to pre-emptively create native images for the assemblies that PowerShell relies on. +to preemptively create native images for the assemblies that PowerShell relies on. Fix high-CPU-on-boot for VMs/cloud instances -------------------------------------------- diff --git a/docs/docsite/rst/playbook_guide/playbooks_reuse.rst b/docs/docsite/rst/playbook_guide/playbooks_reuse.rst index c4c5966d54..9d250fb0ad 100644 --- a/docs/docsite/rst/playbook_guide/playbooks_reuse.rst +++ b/docs/docsite/rst/playbook_guide/playbooks_reuse.rst @@ -1,7 +1,7 @@ .. _playbooks_reuse: ************************** -Re-using Ansible artifacts +Reusing Ansible artifacts ************************** You can write a simple playbook in one very large file, and most users learn the one-file approach first. However, breaking your automation work up into smaller files is an excellent way to organize complex sets of tasks and reuse them. Smaller, more distributed artifacts let you reuse the same variables, tasks, and plays in multiple playbooks to address different use cases. You can use distributed artifacts across multiple parent playbooks or even multiple times within one playbook. For example, you might want to update your customer database as part of several different playbooks. If you put all the tasks related to updating your database in a tasks file or a role, you can reuse them in many playbooks while only maintaining them in one place. @@ -21,7 +21,7 @@ Ansible offers four distributed, reusable artifacts: variables files, task files .. versionadded:: 2.4 -Re-using playbooks +Reusing playbooks ================== You can incorporate multiple playbooks into a main playbook. However, you can only use imports to reuse playbooks. For example: @@ -49,7 +49,7 @@ When to turn a playbook into a role For some use cases, simple playbooks work well. However, starting at a certain level of complexity, roles work better than playbooks. A role lets you store your defaults, handlers, variables, and tasks in separate directories, instead of in a single long document. Roles are easy to share on Ansible Galaxy. For complex use cases, most users find roles easier to read, understand, and maintain than all-in-one playbooks. -Re-using files and roles +Reusing files and roles ======================== Ansible offers two ways to reuse files and roles in a playbook: dynamic and static. @@ -111,7 +111,7 @@ See :ref:`ansible_variable_precedence` for more details on variable inheritance Comparing includes and imports: dynamic and static reuse -------------------------------------------------------- -Each approach to re-using distributed Ansible artifacts has advantages and limitations. You may choose dynamic reuse for some playbooks and static reuse for others. Although you can use both dynamic and static reuse in a single playbook, it is best to select one approach per playbook. Mixing static and dynamic reuse can introduce difficult-to-diagnose bugs into your playbooks. This table summarizes the main differences so you can choose the best approach for each playbook you create. +Each approach to reusing distributed Ansible artifacts has advantages and limitations. You may choose dynamic reuse for some playbooks and static reuse for others. Although you can use both dynamic and static reuse in a single playbook, it is best to select one approach per playbook. Mixing static and dynamic reuse can introduce difficult-to-diagnose bugs into your playbooks. This table summarizes the main differences so you can choose the best approach for each playbook you create. .. table:: :class: documentation-table @@ -150,7 +150,7 @@ Each approach to re-using distributed Ansible artifacts has advantages and limit * There are also big differences in resource consumption and performance, imports are quite lean and fast, while includes require a lot of management and accounting. -Re-using tasks as handlers +Reusing tasks as handlers ========================== You can also use includes and imports in the :ref:`handlers` section of a playbook. For example, if you want to define how to restart Apache, you only have to do that once for all of your playbooks. You might make a ``restarts.yml`` file that looks like: diff --git a/docs/docsite/rst/playbook_guide/playbooks_startnstep.rst b/docs/docsite/rst/playbook_guide/playbooks_startnstep.rst index 22fade9760..87298e6f88 100644 --- a/docs/docsite/rst/playbook_guide/playbooks_startnstep.rst +++ b/docs/docsite/rst/playbook_guide/playbooks_startnstep.rst @@ -17,7 +17,7 @@ To start executing your playbook at a particular task (usually the task that fai ansible-playbook playbook.yml --start-at-task="install packages" -In this example, Ansible starts executing your playbook at a task named "install packages". This feature does not work with tasks inside dynamically re-used roles or tasks (``include_*``), see :ref:`dynamic_vs_static`. +In this example, Ansible starts executing your playbook at a task named "install packages". This feature does not work with tasks inside dynamically reused roles or tasks (``include_*``), see :ref:`dynamic_vs_static`. .. _step: diff --git a/docs/docsite/rst/user_guide/playbooks_reuse.rst b/docs/docsite/rst/user_guide/playbooks_reuse.rst index d27b437a5b..7d5a99c594 100644 --- a/docs/docsite/rst/user_guide/playbooks_reuse.rst +++ b/docs/docsite/rst/user_guide/playbooks_reuse.rst @@ -1,7 +1,7 @@ :orphan: ************************** -Re-using Ansible artifacts +Reusing Ansible artifacts ************************** This page has moved to :ref:`playbooks_reuse`. \ No newline at end of file