docs/Makefile.am: introduce docs/qa-guide.adoc (skeleton so far) [networkupstools#2192, networkupstools#2832]

Signed-off-by: Jim Klimov <[email protected]>

Author: jimklimov

docs/Makefile.am

@@ -124,7 +124,7 @@ CABLES_IMAGES = images/cables/73-0724.png images/cables/940-0024C.jpg \
 
 ALL_TXT_SRC = nut-names.txt daisychain.txt \
  $(USER_MANUAL_DEPS) $(DEVELOPER_GUIDE_DEPS) \
- $(CABLES_DEPS) FAQ.txt nut-qa.txt packager-guide.txt snmp.txt \
+ $(CABLES_DEPS) FAQ.txt nut-qa.txt qa-guide.adoc packager-guide.txt snmp.txt \
  release-notes.txt ChangeLog.txt solaris-usb.txt
 
 ASPELL_FILTER_PATH = @ASPELL_FILTER_PATH@
@@ -148,6 +148,7 @@ ASCIIDOC_HTML_SINGLE = \
 	user-manual.html \
 	developer-guide.html \
 	packager-guide.html \
+	qa-guide.html \
 	release-notes.html \
 	solaris-usb.html \
 	cables.html \
@@ -158,6 +159,7 @@ ASCIIDOC_HTML_CHUNKED = \
 	user-manual.chunked \
 	developer-guide.chunked \
 	packager-guide.chunked \
+	qa-guide.chunked \
 	release-notes.chunked \
 	solaris-usb.chunked \
 	cables.chunked \
@@ -168,6 +170,7 @@ ASCIIDOC_PDF = \
 	user-manual.pdf \
 	developer-guide.pdf \
 	packager-guide.pdf \
+	qa-guide.pdf \
 	release-notes.pdf \
 	solaris-usb.pdf \
 	cables.pdf \
@@ -512,6 +515,7 @@ FULL_DEVELOPER_GUIDE_DEPS = $(DEVELOPER_GUIDE_DEPS) $(SHARED_DEPS) \
 user-manual.html user-manual.chunked user-manual.pdf: $(FULL_USER_MANUAL_DEPS)
 developer-guide.html developer-guide.chunked developer-guide.pdf: $(FULL_DEVELOPER_GUIDE_DEPS)
 packager-guide.html packager-guide.chunked packager-guide.pdf: packager-guide.txt asciidoc.conf
+qa-guide.html qa-guide.chunked qa-guide.pdf: qa-guide.adoc asciidoc.conf
 release-notes.html release-notes.chunked release-notes.pdf: release-notes.txt $(top_builddir)/NEWS.adoc-parsed $(top_builddir)/UPGRADING.adoc-parsed asciidoc.conf
 solaris-usb.html solaris-usb.chunked solaris-usb.pdf: solaris-usb.txt asciidoc.conf
 

docs/qa-guide.adoc

@@ -0,0 +1,94 @@
+NUT Quality Assurance Guide
+===========================
+:Author: Jim_Klimov
+:Author Initials: JK
+
+WARNING: This is a Work In Progress document.
+
+Abstract
+--------
+
+The aim of this document is to describe the different ways we ensure and
+maintain the source code quality of Network UPS Tools, its portability to
+various platforms, and non-regression.
+
+Previous NUT releases may have included parts of this documentation in the
+developer guide or user manual. Most of this information can be applied to
+both automated testing environments and local development workflows.
+
+[[nut-qa]]
+include::nut-qa.txt[leveloffset=+1]
+
+Code and recipe analysis
+------------------------
+
+[[CI_distcheck]]
+GNU Autotools distcheck
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Static analysis by compilers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+[[CI_shellcheck]]
+Shell script checks
+~~~~~~~~~~~~~~~~~~~
+
+[[CI_spellcheck]]
+Documentation spelling checks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+Test automation
+---------------
+
+[[CI_BUILD_SH]]
+The ci_build.sh script
+~~~~~~~~~~~~~~~~~~~~~~
+
+Test programs in NUT codebase
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+[[NIT]]
+NUT Integration Testing suite (NIT)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+[[NUTCI_farm]]
+Continuous Integration (NUT CI farm)
+------------------------------------
+
+Multiple FOSS CI providers and technologies
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Jenkins is the way
+~~~~~~~~~~~~~~~~~~
+
+* https://stories.jenkins.io/user-story/jenkins-is-the-way-for-networkupstools/
+* https://github.com/jenkins-infra/stories/blob/main/src/user-story/jenkins-is-the-way-for-networkupstools/index.yaml
+
+[[Jenkins-Dynamatrix-Library]]
+The jenkins-dynamatrix library
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+[[Jenkins-Dynamatrix-Pipeline]]
+Jenkinsfile-dynamatrix cases in NUT sources
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+[[CI_VM_DigitalOcean]]
+Custom NUT CI farm build agents: VMs on DigitalOcean
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Installation of VMs on Digital Ocean
+  - Pick details from https://github.com/networkupstools/nut/issues/2192
+
+[[CI_LXC]]
+Custom NUT CI farm build agents: LXC containers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+include::ci-farm-lxc-setup.txt[leveloffset=+2]
+
+[[Config_Prereqs]]
+NUT build prerequisites
+-----------------------
+
+include::config-prereqs.txt[leveloffset=+2]