Skip to content

Commit 6895d04

Browse files
Fix codespell issues (#2478) (#2480)
* add entries to codespell ignored words list * fix spelling issues (cherry picked from commit 0591b5f) Co-authored-by: Don Naro <[email protected]>
1 parent 398c806 commit 6895d04

File tree

6 files changed

+12
-10
lines changed

6 files changed

+12
-10
lines changed

.codespellignorewords

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22
aci
33
falsy
44
doas
5+
lets
6+
gotcha

docs/docsite/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ else
1010
CPUS ?= $(shell nproc)
1111
endif
1212

13-
# Intenationalisation and Localisation
13+
# Intenationalisation and Localization
1414
LANGUAGES ?=
1515

1616
# 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
5858
core_generate_rst: collections_meta config cli keywords core_plugins
5959

6060
# At the moment localizing the plugins and collections is not required for the ongoing
61-
# localisation effort. It will come at a later time.
61+
# localization effort. It will come at a later time.
6262
gettext_generate_rst: collections_meta config cli keywords
6363

6464
# The following symlinks are necessary to produce two different docsets

docs/docsite/rst/os_guide/windows_performance.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ PowerShell is used by every Windows Ansible module. This optimization reduces
7171
the time PowerShell takes to start up, removing that overhead from every invocation.
7272

7373
This snippet uses `the native image generator, ngen <https://docs.microsoft.com/en-us/dotnet/framework/tools/ngen-exe-native-image-generator#WhenToUse>`_
74-
to pre-emptively create native images for the assemblies that PowerShell relies on.
74+
to preemptively create native images for the assemblies that PowerShell relies on.
7575

7676
Fix high-CPU-on-boot for VMs/cloud instances
7777
--------------------------------------------

docs/docsite/rst/playbook_guide/playbooks_reuse.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _playbooks_reuse:
22

33
**************************
4-
Re-using Ansible artifacts
4+
Reusing Ansible artifacts
55
**************************
66

77
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
2121

2222
.. versionadded:: 2.4
2323

24-
Re-using playbooks
24+
Reusing playbooks
2525
==================
2626

2727
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
4949

5050
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.
5151

52-
Re-using files and roles
52+
Reusing files and roles
5353
========================
5454

5555
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
111111
Comparing includes and imports: dynamic and static reuse
112112
--------------------------------------------------------
113113

114-
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.
114+
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.
115115

116116
.. table::
117117
:class: documentation-table
@@ -150,7 +150,7 @@ Each approach to re-using distributed Ansible artifacts has advantages and limit
150150
* There are also big differences in resource consumption and performance, imports are quite lean and fast, while includes require a lot of management
151151
and accounting.
152152

153-
Re-using tasks as handlers
153+
Reusing tasks as handlers
154154
==========================
155155

156156
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:

docs/docsite/rst/playbook_guide/playbooks_startnstep.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To start executing your playbook at a particular task (usually the task that fai
1717
1818
ansible-playbook playbook.yml --start-at-task="install packages"
1919
20-
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`.
20+
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`.
2121

2222
.. _step:
2323

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:orphan:
22

33
**************************
4-
Re-using Ansible artifacts
4+
Reusing Ansible artifacts
55
**************************
66

77
This page has moved to :ref:`playbooks_reuse`.

0 commit comments

Comments
 (0)