Fix syntax errors in userdocs/

Signed-off-by: Jonathon Anderson <janderson@ciq.com>

userdocs/contributing/development-environment.rst

@@ -89,10 +89,10 @@ Using a Dev Container
 Visual Studio Code (VSC) can utilize a Dev Container for a self-contained
 environment that has all the necessary tools and dependencies to build and test
 Warewulf. The Dev Container is based on the Rocky 9 image and is built using the
-`devcontainer.json` file in the `.devcontainer` directory of the Warewulf
+``devcontainer.json`` file in the ``.devcontainer`` directory of the Warewulf
 repository.  To use this working Docker/Podman and VSC installations are
 required.  To use the Dev Container, click the "Open a Remote Window" button on
-the bottom left of the editor (`><` icon) and select "Reopen in Container".
+the bottom left of the editor (``><`` icon) and select "Reopen in Container".
 This will build the container and open a new VSC window with the container as
 the development environment. 
 
@@ -100,6 +100,6 @@ Using Vagrant and Libvirt
 =========================
 
 Vagrant can be used to quickly spin up a test/development environment for Warewulf.
-A `Vagrantfile` is provided in `vagrant` directory of the Warewulf repository.
+A ``Vagrantfile`` is provided in ``vagrant`` directory of the Warewulf repository.
 See the `README.md <https://github.com/warewulf/warewulf/blob/main/vagrant/README.md>`_
 for more details.

userdocs/images/images.rst

@@ -345,7 +345,7 @@ particularly easy to do with Apptainer.
 
 .. _OCI base image: https://docs.docker.com/build/building/base-images/
 
-Consider the following file called `warewulf-rockylinux-9.def`:
+Consider the following file called ``warewulf-rockylinux-9.def``:
 
 .. code-block:: singularity
 
@@ -427,7 +427,7 @@ Image Architecture
 
 By default, Warewulf will try to import an image of the same platform (e.g.,
 amd64, arm64) as the local system. To specify the platform to import, either
-specify `WAREWULF_OCI_PLATFORM` or use the argument `--platform` during import.
+specify ``WAREWULF_OCI_PLATFORM`` or use the argument ``--platform`` during import.
 
 It is possible to build, edit, and provision images of different architectures
 (i.e. aarch64) from an x86_64 host by using QEMU. Simply run the appropriate

userdocs/nodes/disks.rst

@@ -55,7 +55,7 @@ sizes should also be set (specified in MiB), except for the last partition: if
 no size is given, the maximum available size is used. Each partition has the
 switches ``should_exist`` and ``wipe_partition_entry`` which control the
 partition creation process (via the ``--partcreate`` and ``--partwipe`` flags).
-When omitting a partition number the `wipe_partition_entry` should be true, as
+When omitting a partition number the ``wipe_partition_entry`` should be true, as
 this allows ignition to replace the existing partition.
 
 .. code-block:: shell
@@ -136,7 +136,7 @@ disk, as necessary.
 If you would like to re-use existing partitions but want to replace existing
 file systems once, you may
 
-* wipe the existing data with tools like ``wipefs`` or `dd` [#]_; or
+* wipe the existing data with tools like ``wipefs`` or ``dd`` [#]_; or
 * set the ``--fswipe`` flag and remove it after one reboot.
 
 .. [#] With ``wipefs`` you have to remove the filesystem *and* parition

userdocs/nodes/ipmi.rst

@@ -13,7 +13,7 @@ Configuration
 Typically, common settings for IPMI interfaces are set on a profile, leaving
 only the IP address set per-node.
 
-If ``--ipmiwrite`` is set to `true`, the ``wwinit`` overlay will write the
+If ``--ipmiwrite`` is set to ``true``, the ``wwinit`` overlay will write the
 desired IPMI configuration to the node's BMC during boot.
 
 .. code-block::

userdocs/overlays/overlays.rst

@@ -408,7 +408,7 @@ debug
 -----
 
 The **debug** overlay is not intended to be used in configuration, but is
-provided as an example. In particular, the provided `tstruct.md.ww` demonstrates
+provided as an example. In particular, the provided ``tstruct.md.ww`` demonstrates
 the use of most available template metadata.
 
 .. code-block:: shell

userdocs/overlays/templates.rst

@@ -216,7 +216,7 @@ UniqueField
 -----------
 
 Returns a filtered version of a multi-line input string. input is expected to be
-a field-separated format with one record per line (terminated by `\n`). Order of
+a field-separated format with one record per line (terminated by ``\n``). Order of
 lines is preserved, with the first matching line taking precedence.
 
 For example, the following template snippet has been used in the ``syncuser`` overlay

userdocs/release/v4.6.0.rst

@@ -102,7 +102,7 @@ will continue to work through the v4.6.x series.
 There are smaller changes to the image system, as well:
 
 - ``wwctl image shell`` now supports a ``WW_HISTFILE`` environment variable to
-  save shell history _inside_ the image.
+  save shell history *inside* the image.
 - ``wwctl image shell`` now supports a ``WW_PS1`` environment variable to
   specify the prompt for the interactive shell. The default prompt has also been
   updated to indicate the current directory.

userdocs/release/v4.6.1.rst

@@ -84,7 +84,7 @@ settings caused surprising deficiencies in some cases; and, in others
   default template is set, ``warewulfd`` looks for a template named "default".
 - If no init is specified, ``wwinit`` now looks for ``/sbin/init``,
   ``/etc/init``, and ``/bin/init``.
-- `wwctl upgrade nodes --replace-overlays` now avoids adding the same overlay
+- ``wwctl upgrade nodes --replace-overlays`` now avoids adding the same overlay
   multiple times to the same node or profile.
 - If, during ``wwctl overlay build``, a node has an empty system or runtime
   overlay, a warning is printed.

userdocs/release/v4.6.4.rst

@@ -61,7 +61,7 @@ Network configuration fixes
   non-ethernet interfaces.
 - The NetworkManager overlay now sets ``ipv4:method=disabled`` if no address or
   route is specified.
-- The ifcfg overlay now sets ``SLAVE=yes`` when `MASTER` is set. #1980
+- The ifcfg overlay now sets ``SLAVE=yes`` when ``MASTER`` is set. #1980
 
 Other fixes
 ===========

userdocs/release/v4.6.5.rst

@@ -16,7 +16,7 @@ A new ``wwctl overlay info`` command lists variables used by an overlay
 template, including the ``wwctl <node|profile> set`` argument used to set that
 variable.
 
-.. code-block: console
+.. code-block:: console
 
    # wwctl overlay info ifcfg /etc/sysconfig/network-scripts/ifcfg.ww
    VARIABLE                OPTION     TYPE                     HELP
@@ -92,7 +92,7 @@ A bug between ``warewulf-dracut`` and the ``ignition`` overlay previously caused
 non-root filesystems from mounting when provisioning the image to disk. A fix in
 ``warewulf-dracut`` prevents ignition from running twice, allowing all file
 systems to mount properly. The ``wwinit`` dracut module also no longer runs the
-wwinit module if root is not set to `root=wwclient*`.
+wwinit module if root is not set to ``root=wwclient*``.
 
 These fixes require installing the updated ``warewulf-dracut`` package in the
 node image.
@@ -100,9 +100,9 @@ node image.
 Other fixes
 ===========
 
-- Enhanced `wwctl configure tftp` to manage the SELinux context of TFTP directory. #1997
+- Enhanced ``wwctl configure tftp`` to manage the SELinux context of TFTP directory. #1997
-- Enhanced overlay templates to support absolute paths with `{{ file }}`. #2055
+- Enhanced overlay templates to support absolute paths with ``{{ file }}``. #2055
 - Fix ImageDelete API not returning error when checking if image is used by nodes/profiles. #1705
-- Fix filesystem overwrite/force behavior in `mkfs` overlay. #2028
+- Fix filesystem overwrite/force behavior in ``mkfs`` overlay. #2028
-- Write `$tftpdir/warewulf/grub.cfg` to `tftproot` as configured in `warewulf.conf`. #2055
+- Write ``$tftpdir/warewulf/grub.cfg`` to ``tftproot`` as configured in ``warewulf.conf``. #2055
-- Automatically create a GPT label when `sfdisk` overlay wipes disks. #2025
+- Automatically create a GPT label when ``sfdisk`` overlay wipes disks. #2025

userdocs/server/bootloaders.rst

@@ -245,7 +245,7 @@ advantage that secure boot can be used. That means that only the signed kernel
 of a distribution can be booted. This can be a huge security benefit for some
 scenarios.
 
-In order to enable the grub boot method it has to be enabled in `warewulf.conf`.
+In order to enable the grub boot method it has to be enabled in ``warewulf.conf``.
 
 .. code-block:: yaml
 
@@ -276,14 +276,14 @@ Secure boot
 If secure boot is enabled at every step a signature is checked and the boot
 process fails if this check fails. The shim typically only includes the key for
 a single operating system, which means that each distribution needs separate
-`shim` and `grub` executables. Warewulf extracts these binaries from the images.
+``shim`` and ``grub`` executables. Warewulf extracts these binaries from the images.
 If the node is unknown to Warewulf or can't be identified during the TFTP boot
 phase, the shim/grub binaries of the host in which Warewulf is running are used.
 
 Install shim and efi
 --------------------
 
-`shim.efi` and `grub.efi` must be installed in the image for it to be
+``shim.efi`` and ``grub.efi`` must be installed in the image for it to be
 booted by GRUB.
 
 .. code-block:: console
@@ -316,7 +316,7 @@ diagram is the following:
       grub->kernel [label="http"];
     }
 
-Warewulf delivers the initial `shim.efi` and `grub.efi` via http as taken
+Warewulf delivers the initial ``shim.efi`` and ``grub.efi`` via http as taken
 directly from the node's assigned image.
 
 .. _booting with dracut:
@@ -394,5 +394,5 @@ during boot.
 
 The wwinit module provisions to tmpfs. By default, tmpfs is permitted to use up
 to 50% of physical memory. This size limit may be adjusted using the kernel
-argument `wwinit.tmpfs.size`. (This parameter is passed to the `size` option
+argument ``wwinit.tmpfs.size``. (This parameter is passed to the ``size`` option
 during tmpfs mount. See ``tmpfs(5)`` for more details.)

userdocs/server/configuration.rst

@@ -109,7 +109,7 @@ warewulf
   can be specified at ``wwclient:port``.)
 
   Changing this option requires rebuilding node overlays and rebooting compute
-  nodes to configure them to use a privileged port for `wwclient`.
+  nodes to configure them to use a privileged port for ``wwclient``.
 
 * ``warewulf:update interval``: This defines the frequency (in seconds) with
   which the Warewulf client on the compute node fetches overlay updates.

userdocs/server/security.rst

@@ -36,7 +36,7 @@ There are multiple ways to secure the Warewulf provisioning process:
   privileged (< 1024) TCP port. This prevents unprivileged cluster users from
   being able to retrieve the runtime overlay.
 
-* When the nodes are booted via `shim` and `grub` Secure Boot can be enabled.
+* When the nodes are booted via ``shim`` and ``grub`` Secure Boot can be enabled.
   This means that the nodes only boot the kernel which is provided by the
   distributor and also custom complied modules can't be loaded.