Add spellcheck and fix misspellings

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @NASA-AMMOS/anms-developers

.github/workflows/docs.yaml

@@ -1,5 +1,5 @@
 ##
-## Copyright (c) 2023 The Johns Hopkins University Applied Physics
+## Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
 ## Laboratory LLC.
 ##
 ## This file is part of the Asynchronous Network Management System (ANMS).
@@ -43,6 +43,7 @@ jobs:
           submodules: recursive
       - name: Set up OS
         run: |
+          sudo rm /var/lib/man-db/auto-update
           sudo apt-get update && sudo apt-get install -y cmake make coreutils ruby asciidoctor graphviz inkscape dblatex docbook-xsl-ns xsltproc xmlstarlet
           sudo gem install asciidoctor-diagram
       - name: Build

.gitlab-ci.yml

@@ -1,5 +1,5 @@
 ##
-## Copyright (c) 2023 The Johns Hopkins University Applied Physics
+## Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
 ## Laboratory LLC.
 ##
 ## This file is part of the Asynchronous Network Management System (ANMS).

CMakeLists.txt

@@ -1,5 +1,5 @@
 #[[
-Copyright (c) 2023 The Johns Hopkins University Applied Physics
+Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
 Laboratory LLC.
 
 This file is part of the Asynchronous Network Management System (ANMS).

CODE_OF_CONDUCT.md

@@ -1,3 +1,24 @@
+<!--
+Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
+Laboratory LLC.
+
+This file is part of the Asynchronous Network Management System (ANMS).
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+This work was performed for the Jet Propulsion Laboratory, California
+Institute of Technology, sponsored by the United States Government under
+the prime contract 80NM0018D0004 between the Caltech and NASA under
+subcontract 1658085.
+-->
 # Code of Conduct - Asynchronous Network Management System (ANMS)
 
 ## Our Pledge

CONTRIBUTING.md

@@ -1,3 +1,25 @@
+<!--
+Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
+Laboratory LLC.
+
+This file is part of the Asynchronous Network Management System (ANMS).
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+This work was performed for the Jet Propulsion Laboratory, California
+Institute of Technology, sponsored by the United States Government under
+the prime contract 80NM0018D0004 between the Caltech and NASA under
+subcontract 1658085.
+-->
+
 <!-- omit in toc -->
 # Contributing to Asynchronous Network Management System (ANMS)
 

README.md

@@ -1,5 +1,5 @@
 <!--
-Copyright (c) 2023 The Johns Hopkins University Applied Physics
+Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
 Laboratory LLC.
 
 This file is part of the Asynchronous Network Management System (ANMS).

apply_license.sh

@@ -0,0 +1,60 @@
+#!/bin/bash
+##
+## Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
+## Laboratory LLC.
+##
+## This file is part of the Asynchronous Network Management System (ANMS).
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+##     http://www.apache.org/licenses/LICENSE-2.0
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+## This work was performed for the Jet Propulsion Laboratory, California
+## Institute of Technology, sponsored by the United States Government under
+## the prime contract 80NM0018D0004 between the Caltech and NASA under
+## subcontract 1658085.
+##
+
+# Apply copyright and license markings to source files.
+#
+# Requires installation of:
+#  pip3 install licenseheaders
+# Run as:
+#  ./apply_license.sh {specific dir}
+#
+set -e
+
+SELFDIR=$(realpath $(dirname "${BASH_SOURCE[0]}"))
+
+LICENSEOPTS="${LICENSEOPTS} --tmpl ${SELFDIR}/apply_license.tmpl"
+LICENSEOPTS="${LICENSEOPTS} --years 2023-$(date +%Y)"
+# Excludes only apply to directory (--dir) mode and not file mode
+#LICENSEOPTS="${LICENSEOPTS} --exclude *.yml "
+
+
+# Specific paths
+if [[ $# -gt 0 ]]
+then
+    echo "Applying markings to selected $@ ..."
+    licenseheaders ${LICENSEOPTS} --dir $@
+    exit 0
+fi
+
+
+echo "Applying markings to source..."
+# Directory trees
+for DIRNAME in product-guide user-guide .github
+do
+    licenseheaders ${LICENSEOPTS} --dir ${SELFDIR}/${DIRNAME}
+done
+# Specific top-level files
+for FILEPATH in $(find "${SELFDIR}" -maxdepth 1 -type f)
+do
+    licenseheaders ${LICENSEOPTS} --file ${FILEPATH}
+done

build.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 ##
-## Copyright (c) 2023 The Johns Hopkins University Applied Physics
+## Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
 ## Laboratory LLC.
 ##
 ## This file is part of the Asynchronous Network Management System (ANMS).

index.html

@@ -1,4 +1,25 @@
 <!DOCTYPE html>
+<!--
+-- Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
+-- Laboratory LLC.
+--
+-- This file is part of the Asynchronous Network Management System (ANMS).
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--     http://www.apache.org/licenses/LICENSE-2.0
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+-- This work was performed for the Jet Propulsion Laboratory, California
+-- Institute of Technology, sponsored by the United States Government under
+-- the prime contract 80NM0018D0004 between the Caltech and NASA under
+-- subcontract 1658085.
+-->
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>

product-guide/CMakeLists.txt

@@ -1,5 +1,5 @@
 #[[
-Copyright (c) 2023 The Johns Hopkins University Applied Physics
+Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
 Laboratory LLC.
 
 This file is part of the Asynchronous Network Management System (ANMS).
@@ -35,6 +35,11 @@ set(ADOC_EXTRAS
 
 
 find_program(ASCIIDOC asciidoctor REQUIRED)
+find_program(ASPELL aspell)
+if(NOT ASPELL)
+    message(FATAL_ERROR "Program aspell not found")
+endif()
+
 set(OUT_DOCINFO "docinfo.xml")
 configure_file(
   "${CMAKE_CURRENT_SOURCE_DIR}/${OUT_DOCINFO}.in"
@@ -53,10 +58,11 @@ add_custom_command(
     ${ADOC_SOURCE}
 )
 # Place source images into build directory
+set(INSTALL_IMGS ${CMAKE_CURRENT_SOURCE_DIR}/install_imgs.sh)
 add_custom_target(
   ${PROJECT_NAME}-img-bin
-  DEPENDS ${CMAKE_SOURCE_DIR}/install_imgs.sh ${OUT_DBOOK}
-  COMMAND ${CMAKE_SOURCE_DIR}/install_imgs.sh ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR} ${OUT_DBOOK}
+  DEPENDS ${INSTALL_IMGS} ${OUT_DBOOK}
+  COMMAND ${INSTALL_IMGS} ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR} ${OUT_DBOOK}
 )
 
 find_program(XSLTPROC xsltproc REQUIRED)
@@ -73,8 +79,8 @@ add_custom_command(
 # Place needed images into HTML tree
 add_custom_target(
   ${PROJECT_NAME}-img-html
-  DEPENDS ${CMAKE_SOURCE_DIR}/install_imgs.sh ${OUT_HTML} ${PROJECT_NAME}-img-bin
-  COMMAND ${CMAKE_SOURCE_DIR}/install_imgs.sh ${CMAKE_CURRENT_BINARY_DIR} "${CMAKE_CURRENT_BINARY_DIR}/html"
+  DEPENDS ${INSTALL_IMGS} ${OUT_HTML} ${PROJECT_NAME}-img-bin
+  COMMAND ${INSTALL_IMGS} ${CMAKE_CURRENT_BINARY_DIR} "${CMAKE_CURRENT_BINARY_DIR}/html"
 )
 add_custom_target(
   ${PROJECT_NAME}-html ALL
@@ -86,6 +92,34 @@ install(
 )
 
 
+# spellcheck on HTML output
+set(DICTIONARY_TXT "${CMAKE_CURRENT_SOURCE_DIR}/dictionary.txt")
+set(SPELLCHECK_XSL "${CMAKE_CURRENT_SOURCE_DIR}/spellcheck.xsl")
+set(MISSPELLING_TXT "misspelling.txt")
+add_custom_command(
+    OUTPUT "dictionary.cwl"
+    DEPENDS "${DICTIONARY_TXT}"
+    COMMAND cat "${DICTIONARY_TXT}" |
+        ${ASPELL} --lang=en create master "./dictionary.cwl"
+)
+add_custom_command(
+    OUTPUT "${MISSPELLING_TXT}"
+    DEPENDS "${OUT_HTML}" "${SPELLCHECK_XSL}" "dictionary.cwl"
+    COMMAND ${XMLSTARLET} tr "${SPELLCHECK_XSL}" "${OUT_HTML}" |
+        ${ASPELL} --mode=html --lang=EN_US --extra-dicts=./dictionary.cwl list |
+        sort | uniq > "${MISSPELLING_TXT}"
+)
+add_custom_target(
+    ${PROJECT_NAME}-misspelling ALL
+    DEPENDS "${MISSPELLING_TXT}"
+    COMMAND cat "${MISSPELLING_TXT}"
+    # success means file is present and empty
+    COMMAND test -f "${MISSPELLING_TXT}" -a ! -s "${MISSPELLING_TXT}"
+    COMMENT "Checking ${MISSPELLING_TXT}"
+)
+
+
+# PDF document output
 find_program(DBLATEX dblatex REQUIRED)
 set(PDF_XSLT "${CMAKE_CURRENT_SOURCE_DIR}/pdf-opts.xsl")
 set(OUT_PDF "manual.pdf")

product-guide/dictionary.txt

@@ -0,0 +1,90 @@
+adminer
+ADMs
+AMMOS
+anms
+ANMS
+APIs
+APL
+args
+ARI
+auth
+Auth
+authnz
+AUTHNZ
+backend
+bookkeep
+BPA
+Caltech
+CLA
+CLI
+CODEC
+DNS
+Dockerfile
+dtn
+EID
+env
+filesystem
+Filesystem
+FIPS
+frontend
+Frontend
+GiB
+Grafana
+healthchecks
+hostname
+http
+https
+HTTPS
+instantiation
+JHU
+JPL
+LLC
+ltp
+LTPCL
+MGSS
+microservice
+MMCS
+MQTT
+nm
+opensearch
+OpenSearch
+orchestrator
+PEM
+PKI
+PKIX
+podman
+Podman
+postgres
+Postgres
+pre
+PSQL
+RDD
+RedHat
+redis
+REFDM
+renderer
+resolveable
+RESTful
+rhel
+RHEL
+selinux
+SELinux
+submodule
+systemd
+TBD
+TCP
+testenv
+TLS
+transcoder
+transcoding
+tshark
+Tshark
+udp
+UDPCL
+ui
+UI
+un
+VNC
+wireshark
+Wireshark
+yml