fix(doc): Fix spelling errors found by sphinxcontrib-spelling (canoni…

…cal#3639)
georgehyde-dot · Dec 8, 2023 · 3e7caf3 · 3e7caf3
1 parent 75ee2f0
commit 3e7caf3
Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/cloudinit/config/schemas/schema-cloud-config-v1.json b/cloudinit/config/schemas/schema-cloud-config-v1.json
@@ -231,11 +231,11 @@
           "type": "boolean"
         },
         "passwd": {
-          "description": "Hash of user password applied when user does not exist. This will NOT be applied if the user already exists. To generate this hash, run: mkpasswd --method=SHA-512 --rounds=500000 **Note:** Your password might possibly be visible to unprivileged users on your system, depending on your cloud's security model. Check if your cloud's IMDS server is visible from an unprivileged user to evaluate risk.",
+          "description": "Hash of user password applied when user does not exist. This will NOT be applied if the user already exists. To generate this hash, run: ``mkpasswd --method=SHA-512 --rounds=500000`` **Note:** Your password might possibly be visible to unprivileged users on your system, depending on your cloud's security model. Check if your cloud's IMDS server is visible from an unprivileged user to evaluate risk.",
           "type": "string"
         },
         "hashed_passwd": {
-          "description": "Hash of user password to be applied. This will be applied even if the user is preexisting. To generate this hash, run: mkpasswd --method=SHA-512 --rounds=500000. **Note:** Your password might possibly be visible to unprivileged users on your system, depending on your cloud's security model. Check if your cloud's IMDS server is visible from an unprivileged user to evaluate risk.",
+          "description": "Hash of user password to be applied. This will be applied even if the user is preexisting. To generate this hash, run: ``mkpasswd --method=SHA-512 --rounds=500000``. **Note:** Your password might possibly be visible to unprivileged users on your system, depending on your cloud's security model. Check if your cloud's IMDS server is visible from an unprivileged user to evaluate risk.",
           "type": "string"
         },
         "plain_text_passwd": {
@@ -871,7 +871,7 @@
             },
             "conf": {
               "type": "string",
-              "description": "Specify configuration for apt, such as proxy configuration. This configuration is specified as a string. For mult-line APT configuration, make sure to follow YAML syntax."
+              "description": "Specify configuration for apt, such as proxy configuration. This configuration is specified as a string. For multi-line APT configuration, make sure to follow YAML syntax."
             },
             "https_proxy": {
               "type": "string",
@@ -1095,7 +1095,7 @@
             "log_location": {
               "type": "string",
               "default": "/var/log/chef/client.log",
-              "description": "Specifies the location of the chef lof file. By default, the location is specified at ``/var/log/chef/client.log``."
+              "description": "Specifies the location of the chef log file. By default, the location is specified at ``/var/log/chef/client.log``."
             },
             "node_name": {
               "type": "string",

diff --git a/cloudinit/features.py b/cloudinit/features.py
@@ -62,7 +62,7 @@
 NETPLAN_CONFIG_ROOT_READ_ONLY = True
 """
 If ``NETPLAN_CONFIG_ROOT_READ_ONLY`` is True, then netplan configuration will
-be written as a single root readon-only file /etc/netplan/50-cloud-init.yaml.
+be written as a single root read-only file /etc/netplan/50-cloud-init.yaml.
 This prevents wifi passwords in network v2 configuration from being
 world-readable. Prior to 23.1, netplan configuration is world-readable.
 

diff --git a/doc/rtd/explanation/instancedata.rst b/doc/rtd/explanation/instancedata.rst
@@ -332,8 +332,8 @@ The internal or local hostname of the system.
 
 Example output:
 
-  - ip-10-41-41-70
-  - <user-provided-hostname>
+  - ``ip-10-41-41-70``
+  - ``<user-provided-hostname>``
 
 ``v1.machine``
 ^^^^^^^^^^^^^^