summaryrefslogtreecommitdiff
path: root/doc/rtd
diff options
context:
space:
mode:
authorBrett Holman <bholman.devel@gmail.com>2022-02-02 14:21:00 -0700
committerGitHub <noreply@github.com>2022-02-02 15:21:00 -0600
commit7522845dfe8851b7b4f3e9924810b9ccf282bb6e (patch)
tree0f40492cf5bc32bc5084ca9a4cf8983abf963271 /doc/rtd
parent490cefd72d6e282804b877e9448438247e956f34 (diff)
downloadvyos-cloud-init-7522845dfe8851b7b4f3e9924810b9ccf282bb6e.tar.gz
vyos-cloud-init-7522845dfe8851b7b4f3e9924810b9ccf282bb6e.zip
spell check docs with spellintian (#1223)
Fix spelling errors - Add Makefile target that checks for spelling errors - Add Makefile target that fixes spelling errors - Add spelling check to travis doc tests - Fix various spelling errors in the docs
Diffstat (limited to 'doc/rtd')
-rw-r--r--doc/rtd/conf.py2
-rw-r--r--doc/rtd/topics/datasources.rst2
-rw-r--r--doc/rtd/topics/datasources/smartos.rst2
-rw-r--r--doc/rtd/topics/datasources/vmware.rst2
-rw-r--r--doc/rtd/topics/datasources/vultr.rst2
-rw-r--r--doc/rtd/topics/faq.rst6
-rw-r--r--doc/rtd/topics/instancedata.rst4
-rw-r--r--doc/rtd/topics/network-config-format-v1.rst4
8 files changed, 12 insertions, 12 deletions
diff --git a/doc/rtd/conf.py b/doc/rtd/conf.py
index d2cb6ae1..9976afa4 100644
--- a/doc/rtd/conf.py
+++ b/doc/rtd/conf.py
@@ -12,7 +12,7 @@ sys.path.insert(0, os.path.abspath("./"))
sys.path.insert(0, os.path.abspath("."))
-# Supress warnings for docs that aren't used yet
+# Suppress warnings for docs that aren't used yet
# unused_docs = [
# ]
diff --git a/doc/rtd/topics/datasources.rst b/doc/rtd/topics/datasources.rst
index 0ebc0f32..4d9a3eca 100644
--- a/doc/rtd/topics/datasources.rst
+++ b/doc/rtd/topics/datasources.rst
@@ -99,7 +99,7 @@ need to take care of the following items:
your datasource module name to the end of the ``datasource_list``
entry in ``cloudinit/settings.py``.
-* **Add your your cloud platform to apport collection prompts:** Update the
+* **Add your cloud platform to apport collection prompts:** Update the
list of cloud platforms in ``cloudinit/apport.py``. This list will be
provided to the user who invokes ``ubuntu-bug cloud-init``.
diff --git a/doc/rtd/topics/datasources/smartos.rst b/doc/rtd/topics/datasources/smartos.rst
index be11dfbb..6c53f684 100644
--- a/doc/rtd/topics/datasources/smartos.rst
+++ b/doc/rtd/topics/datasources/smartos.rst
@@ -13,7 +13,7 @@ SmartOS Platform
The SmartOS virtualization platform uses meta-data to the instance via the
second serial console. On Linux, this is /dev/ttyS1. The data is a provided
via a simple protocol: something queries for the data, the console responds
-responds with the status and if "SUCCESS" returns until a single ".\n".
+with the status and if "SUCCESS" returns until a single ".\n".
New versions of the SmartOS tooling will include support for base64 encoded
data.
diff --git a/doc/rtd/topics/datasources/vmware.rst b/doc/rtd/topics/datasources/vmware.rst
index 3ca9f10f..df5bf5aa 100644
--- a/doc/rtd/topics/datasources/vmware.rst
+++ b/doc/rtd/topics/datasources/vmware.rst
@@ -333,7 +333,7 @@ Setting the instance ID
^^^^^^^^^^^^^^^^^^^^^^^
The instance ID may be set by way of the metadata key ``instance-id``. However,
-if this value is absent then then the instance ID is read from the file
+if this value is absent then the instance ID is read from the file
``/sys/class/dmi/id/product_uuid``.
Providing public SSH keys
diff --git a/doc/rtd/topics/datasources/vultr.rst b/doc/rtd/topics/datasources/vultr.rst
index e73406a8..9a5bbf96 100644
--- a/doc/rtd/topics/datasources/vultr.rst
+++ b/doc/rtd/topics/datasources/vultr.rst
@@ -21,7 +21,7 @@ Vultr's datasource can be configured as follows:
timeout: 2
wait: 2
-- *url*: The URL used to aquire the metadata configuration from
+- *url*: The URL used to acquire the metadata configuration from
- *retries*: Determines the number of times to attempt to connect to the
metadata service
- *timeout*: Determines the timeout in seconds to wait for a response from the
diff --git a/doc/rtd/topics/faq.rst b/doc/rtd/topics/faq.rst
index efc532de..125ce9f4 100644
--- a/doc/rtd/topics/faq.rst
+++ b/doc/rtd/topics/faq.rst
@@ -56,7 +56,7 @@ instance
--------
The `/var/lib/cloud/instance` directory is a symbolic link that points
-to the most recenlty used instance-id directory. This folder contains the
+to the most recently used instance-id directory. This folder contains the
information cloud-init received from datasources, including vendor and user
data. This can be helpful to review to ensure the correct data was passed.
@@ -74,9 +74,9 @@ previous boot:
* `instance-id`: id of the instance as discovered by cloud-init. Changing
this file has no effect.
* `result.json`: json file will show both the datasource used to setup
- the instance, and if any errors occured
+ the instance, and if any errors occurred
* `status.json`: json file shows the datasource used and a break down
- of all four modules if any errors occured and the start and stop times.
+ of all four modules if any errors occurred and the start and stop times.
What datasource am I using?
===========================
diff --git a/doc/rtd/topics/instancedata.rst b/doc/rtd/topics/instancedata.rst
index c33b907a..2d6719fd 100644
--- a/doc/rtd/topics/instancedata.rst
+++ b/doc/rtd/topics/instancedata.rst
@@ -30,7 +30,7 @@ deployed with cloud-init:
* simple static object to query to obtain a instance's metadata
* speed: avoid costly network transactions for metadata that is already cached
- on the filesytem
+ on the filesystem
* reduce need to recrawl metadata services for static metadata that is already
cached
* leverage cloud-init's best practices for crawling cloud-metadata services
@@ -180,7 +180,7 @@ Example output:
v1.platform
-------------
-An attempt to identify the cloud platfrom instance that the system is running
+An attempt to identify the cloud platform instance that the system is running
on.
Examples output:
diff --git a/doc/rtd/topics/network-config-format-v1.rst b/doc/rtd/topics/network-config-format-v1.rst
index 4c013d92..a3beccbd 100644
--- a/doc/rtd/topics/network-config-format-v1.rst
+++ b/doc/rtd/topics/network-config-format-v1.rst
@@ -48,7 +48,7 @@ the key ``subnets``.
Physical
~~~~~~~~
The ``physical`` type configuration represents a "physical" network device,
-typically Ethernet-based. At least one of of these entries is required for
+typically Ethernet-based. At least one of these entries is required for
external network connectivity. Type ``physical`` requires only one key:
``name``. A ``physical`` device may contain some or all of the following
keys:
@@ -335,7 +335,7 @@ Users can specify a ``nameserver`` type. Nameserver dictionaries include
the following keys:
- ``address``: List of IPv4 or IPv6 address of nameservers.
-- ``search``: List of of hostnames to include in the resolv.conf search path.
+- ``search``: List of hostnames to include in the resolv.conf search path.
- ``interface``: Optional. Ties the nameserver definition to the specified
interface. The value specified here must match the `name` of an interface
defined in this config. If unspecified, this nameserver will be considered