ci: support spellcheck of markdown and rst files

.github/spellcheck_config.yml

@@ -0,0 +1,30 @@
+# ---------------------------------------------------------------------------
+# CI workflows for MTDA
+# ---------------------------------------------------------------------------
+#
+# This software is a part of MTDA.
+# Copyright (C) 2023 Siemens Digital Industries Software
+#
+# ---------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# ---------------------------------------------------------------------------
+
+matrix:
+- name: Markdown
+  aspell:
+    lang: en
+  dictionary:
+    wordlists:
+    - .github/wordlist.txt
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+  - pyspelling.filters.html:
+      comments: false
+      ignores:
+      - code
+      - pre
+  sources:
+  - '**/*.md'
+  - 'docs/*.rst'
+  default_encoding: utf-8

.github/wordlist.txt

@@ -0,0 +1,130 @@
+# ---------------------------------------------------------------------------
+# CI workflows for MTDA
+# ---------------------------------------------------------------------------
+#
+# This software is a part of MTDA.
+# Copyright (C) 2023 Siemens Digital Industries Software
+#
+# ---------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# ---------------------------------------------------------------------------
+
+ACM
+Allwinner
+amd
+api
+APIs
+ARCELI
+aviosys
+boolean
+cedric
+chmod
+chombourger
+CIDR
+config
+de
+dearmor
+dev
+DHCP
+DNS
+dpkg
+DUT
+EEPROM
+faq
+Fi
+FriendlyARM
+FriendlyElec
+fsSL
+GiB
+github
+GND
+gnutls
+googlegroups
+gpg
+GPIO
+GStreamer
+hombourger
+homekit
+HomeKit
+hostname
+http
+https
+img
+INI
+io
+ip
+IoT
+jinja
+jpc
+jpg
+jqc
+JQC
+keyrings
+kvm
+LEDs
+LTS
+maxdepth
+microSD
+microUSB
+MiB
+MJPEG
+mtda
+MTDA's
+Mux
+MUX
+nano
+NanoPi
+neo
+netmask
+nmcli
+OTG
+pastebin
+pdu
+php
+pinout
+png
+ppa
+prebuilt
+programmatically
+pytest
+qemu
+rc
+RFB
+RJ
+quickstart
+samsung
+SBC
+sdmux
+SDmux
+SDMux
+sdwire
+SDWire
+siemens
+siri
+SL
+SoC
+SRD
+ssd
+stdout
+systemd
+sudo
+tc
+toctree
+Terasic's
+Tihokile
+tizen
+Tizen's
+TPM
+tpmtool
+ttyS
+UI
+unmuted
+uncomment
+Uptime
+usb
+vdc
+VDC
+VLC
+VNC
+Wi
+www

.github/workflows/spellcheck.yml

@@ -0,0 +1,32 @@
+# ---------------------------------------------------------------------------
+# CI workflows for MTDA
+# ---------------------------------------------------------------------------
+#
+# This software is a part of MTDA.
+# Copyright (C) 2023 Siemens Digital Industries Software
+#
+# ---------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# ---------------------------------------------------------------------------
+
+name: Spellcheck
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+  pull_request:
+    types: [ labeled ]
+
+jobs:
+  build:
+    name: Spellcheck Markdown and ReStructuredText files
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rojopolis/spellcheck-github-actions@0.34.0
+        name: Spellcheck
+        with:
+          config_path: .github/spellcheck_config.yml

docs/build.rst

@@ -8,7 +8,7 @@ with additional electronic gadgets.
 KVM
 ---
 
-If you do not have a Single Board Computer (SBC) such as the NanoPI NEO-LTS, you
+If you do not have a Single Board Computer (SBC) such as the NanoPi NEO-LTS, you
 may start with KVM. Instead of controlling a physical device, MTDA will spawn a
 virtual machine. It will provide a virtual hard disk for the operating system,
 a virtual USB drive to install the system from and a virtual serial port to
@@ -158,7 +158,7 @@ and install the updated packages::
     Processing triggers for man-db (2.9.1-1) ...
     Processing triggers for libc-bin (2.31-0ubuntu9) ...
 
-NanoPI R1
+NanoPi R1
 ---------
 
 The NanoPi R1 ("R1") is a complete open source board developed by FriendlyElec
@@ -177,19 +177,19 @@ following functions will be exposed:
    Device Under Test may use this virtual serial port to provide a login
    shell to MTDA clients.
 
- * HID: the NanoPI R1 will be seen as a keyboard. This may be used by e.g.
+ * HID: the NanoPi R1 will be seen as a keyboard. This may be used by e.g.
    ``power on`` scripts to enter the firmware of the Device Under Test to
    select a boot media (SSD or USB).
 
  * Mass Storage: a USB stick will be connected to the USB Host available on the
-   NanoPI R1 and will be exposed to the Device Under Test. MTDA will allow
+   NanoPi R1 and will be exposed to the Device Under Test. MTDA will allow
    clients to write a new OS image for the device it is connected to.
 
 Building the microSD card image
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Use ``kas-container`` to build a Debian image for the nanoPI R1 with MTDA
-pre-installed::
+Use ``kas-container`` to build a Debian image for the NanoPi R1 with MTDA
+preinstalled::
 
     $ ./kas-container build kas/debian/mtda-nanopi-r1.yml
 
@@ -201,10 +201,10 @@ Insert a microSD card to your system and write the generated image::
 
 (replace ``/dev/mmcblk0`` with the actual SD card device on your system).
 
-Booting the NanoPI R1
+Booting the NanoPi R1
 ~~~~~~~~~~~~~~~~~~~~~
 
-Insert the microSD card created above into the microSD card slot of your NanoPI
+Insert the microSD card created above into the microSD card slot of your NanoPi
 R1 and connect the board to your network. Attach a formatted USB stick to
 the USB-Host port. Lastly, get a USB Y cable with one end connected to a fixed
 USB power source (2A) and the other end connected to the Device Under Test. The
@@ -228,7 +228,7 @@ The following diagram shows the various connections described above:
 Configuring MTDA
 ~~~~~~~~~~~~~~~~
 
-A configuration file should be created on the NanoPI R1. Use ``ssh`` to connect
+A configuration file should be created on the NanoPi R1. Use ``ssh`` to connect
 with the ``mtda`` user and then ``sudo`` to get elevated privileges::
 
     $ ssh mtda@172.17.0.50
@@ -279,7 +279,7 @@ to the shell and may restart the agent::
 Clients may now connect to the MTDA agent, control the power input of the Device
 Under Test and remotely access its console.
 
-NanoPI NEO-LTS
+NanoPi NEO-LTS
 --------------
 
 The NanoPi NEO (abbreviated as NEO) is another fun board developed by
@@ -298,19 +298,19 @@ where the following functions will be exposed:
    Device Under Test may use this virtual serial port to provide a login
    shell to MTDA clients.
 
- * HID: the NanoPI NEO-LTS will be seen as a keyboard. This may be used by e.g.
+ * HID: the NanoPi NEO-LTS will be seen as a keyboard. This may be used by e.g.
    ``power on`` scripts to enter the firmware of the Device Under Test to
    select a boot media (SSD or USB).
 
  * Mass Storage: a USB stick will be connected to the USB Host available on the
-   NanoPI NEO-LTS and will be exposed to the Device Under Test. MTDA will allow
+   NanoPi NEO-LTS and will be exposed to the Device Under Test. MTDA will allow
    clients to write a new OS image for the device it is connected to.
 
 Building the microSD card image
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Use ``kas-container`` to build a Debian image for the nanoPI NEO-LTS with MTDA
-pre-installed::
+Use ``kas-container`` to build a Debian image for the NanoPi NEO-LTS with MTDA
+preinstalled::
 
     $ ./kas-container build kas/debian/mtda-nanopi-neo.yml
 
@@ -325,15 +325,15 @@ Insert a microSD card to your system and write the generated image::
 Applying external power
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-The NanoPI NEO-LTS usually gets powered over its USB-OTG interface. Since we
+The NanoPi NEO-LTS usually gets powered over its USB-OTG interface. Since we
 will attach this port to the Device Under Test, we need to apply external
 power instead. Re-purpose a USB cable and connect its red wire to #2 (5V IN)
 and its black wire to #6 (GND).
 
-Booting the NanoPI NEO-LTS
+Booting the NanoPi NEO-LTS
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Insert the microSD card created above into the microSD card slot of your NanoPI
+Insert the microSD card created above into the microSD card slot of your NanoPi
 NEO-LTS and connect the board to your network. Attach a formatted USB stick to
 the USB-Host port. Lastly, get a microUSB cable, connect your system and the
 NEO together. The red LED of the NEO should light up as well as the LEDs from
@@ -349,7 +349,7 @@ We will use a 5V relay such as the JQC3F-05VDC pictured below:
 
 .. image:: jqc3f-05vdc.jpg
 
-It requires a 5V line, ground and signal. Here is the pin-out of our NanoPI
+It requires a 5V line, ground and signal. Here is the pin-out of our NanoPi
 NEO-LTS:
 
 .. image:: neo_pinout.jpg
@@ -368,7 +368,7 @@ The following diagram shows the various connections described above:
 Configuring MTDA
 ~~~~~~~~~~~~~~~~
 
-A configuration file should be created on the NanoPI NEO-LTS. Use ``ssh`` to
+A configuration file should be created on the NanoPi NEO-LTS. Use ``ssh`` to
 connect with the ``mtda`` user and then ``sudo`` to get elevated privileges::
 
     $ ssh mtda@172.17.0.2
@@ -456,5 +456,5 @@ The following configuration file may be used for the DE0-Nano-SoC::
     device=/dev/sda
 
 where ``sdwire1`` is the serial number programmed into the SDWire EEPROM. Use
-``sd-mux-ctrl -l`` to list SDWire devices connected to your NanoPI NEO and
+``sd-mux-ctrl -l`` to list SDWire devices connected to your NanoPi NEO and
 obtain their serial number.

docs/config.rst

@@ -248,7 +248,7 @@ physical device. The following settings are supported:
 
 * ``command``: string [optional]
     The command to execute when the container is started. The default
-    commmand is ``sh``.
+    command is ``sh``.
 
 ``gpio`` driver settings
 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -262,7 +262,7 @@ supported:
     Format: <gpiochipx>@<pin>
     If multiple GPIO lines and pins are used separate the entries using ','.
 
-    eg:::
+    Example::
 
         # For single GPIO line
         gpio = gpiochip0@201

docs/fixtures.rst

@@ -7,7 +7,7 @@ Multi-function test fixtures
 USB Function
 ~~~~~~~~~~~~
 
-When the MTDA agent is running on devices such as the NanoPI NEO, it may
+When the MTDA agent is running on devices such as the NanoPi NEO, it may
 provide the following USB functions to the DUT:
 
  * USB Mass Storage

docs/integration.rst

@@ -111,8 +111,8 @@ Sign in to your account with the created superuser. Login should be successful.
 Attach to lava-server
 ~~~~~~~~~~~~~~~~~~~~~
 
-The sample NanoPI NEO image comes with the ``lava-dispatcher`` package
-pre-installed. It however needs to be configured to connect to the LAVA server
+The sample NanoPi NEO image comes with the ``lava-dispatcher`` package
+preinstalled. It however needs to be configured to connect to the LAVA server
 and logger installed as noted above. You may connect to the MTDA agent using
 ``ssh`` (default credentials are ``mtda``/``mtda``)::