Enable CI checkers

.github/.wordlist.txt

@@ -0,0 +1,9 @@
+anuket
+Baraque
+Kubernetes
+Lakelse
+OpenStack
+sexualized
+Snezka
+socio
+tsc

.gitignore

@@ -6,3 +6,4 @@ doc/.DS_Store
 _build/
 .tox/
 .vscode/
+*.dic

.rstcheck.cfg

@@ -0,0 +1,4 @@
+[rstcheck]
+report_level=ERROR
+ignore_directives=bibliography,
+ignore_roles=cite:p,

.spellcheck.yml

@@ -0,0 +1,21 @@
+---
+# SPDX-license-identifier: Apache-2.0
+##############################################################################
+# Copyright (c) 2022 Samsung Corporation
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+matrix:
+  - name: markdown
+    dictionary:
+      wordlists:
+        - .github/.wordlist.txt
+    pipeline:
+      - pyspelling.filters.html:
+    sources:
+      - '_build/html/*.html'
+    aspell:
+      ignore-case: true

Makefile

@@ -0,0 +1,13 @@
+# SPDX-license-identifier: Apache-2.0
+##############################################################################
+# Copyright (c) 2022 Samsung Corporation
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+.PHONY: deploy
+deploy:
+	tox -e docs
+	python -m http.server --directory _build/html/

doc/gov/chapters/chapter09.rst

@@ -220,7 +220,8 @@ experience. This survey will be used to measure the feasibility, utility, and ef
 installation/configuration methods and RC-1 Test case efficacy. The survey will be in an Agile User Story format. The
 Table below provides an example of the survey questions:
 
-![\ **Table 1:** Survey/Questionnaire example](../figures/Table 1-1.png)
+.. image:: ../figures/Table_1-1.png
+   :alt: "Table 1: Survey/Questionnaire example"
 
 **Table 1:** Survey/Questionnaire example
 

test-requirements.txt

@@ -4,3 +4,5 @@
 sphinx!=1.6.6,!=1.6.7,!=2.1.0,!=3.0.0,!=3.4.2 # BSD
 doc8 # Apache-2.0
 sphinx-material
+pyspelling # MIT
+rstcheck[sphinx] # MIT

tox.ini

@@ -6,9 +6,13 @@ skipsdist = true
 
 [testenv:docs]
 basepython = python3.10
+allowlist_externals = bash
 deps =
   -chttps://opendev.org/openstack/requirements/raw/branch/stable/zed/upper-constraints.txt
   -r{toxinidir}/test-requirements.txt
 commands =
+    bash -c "find {toxinidir} -not -path {toxinidir}/.tox/\* \
+    -name \*.rst -type f -print0 | xargs -0 rstcheck"
     sphinx-build -W --keep-going -W -T -b html -D language=en doc _build/html
     sphinx-build -W --keep-going -W -b linkcheck doc _build/html
+    pyspelling -c .spellcheck.yml