Skip to content

Commit db39996

Browse files
committed
docs/nut-qa.txt: revise markup to be a chapter, not book [networkupstools#2832]
Signed-off-by: Jim Klimov <[email protected]>
1 parent 8d93fe9 commit db39996

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

docs/nut-qa.txt

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
NUT Quality Assurance
2-
=====================
2+
---------------------
33

44
Recognizing the critical nature of NUT, the NUT Quality Assurance (NQA) effort
55
has been established to improve NUT where necessary, and to maintain software
@@ -8,7 +8,7 @@ quality as high as it should be.
88
NQA is present in many aspects and areas of NUT.
99

1010
Documentation
11-
-------------
11+
~~~~~~~~~~~~~
1212

1313
The documentation toolchain uses
1414
link:https://asciidoc.org/[AsciiDoc] to output both HTML pages and
@@ -17,28 +17,28 @@ suppresses many redundancies, and optimizes documentation management in
1717
general.
1818

1919
- The NUT website and HTML documentation are tested for W3C XHTML 1.1 and CSS
20-
compliance. This can be counter verified by clicking the W3C XHTML 1.1 and CSS
21-
icons, at the bottom of each page.
20+
compliance. This can be counter verified by clicking the W3C XHTML 1.1 and
21+
CSS icons, at the bottom of each page.
2222

2323
////////////////////////////////////////////////////////////////////////////////
2424
- the manual pages conformance is tested with
2525
link:http://catb.org/~esr/doclifter/index.html[doclifter] (outdated)
2626
////////////////////////////////////////////////////////////////////////////////
2727

2828
- Documentation source files are spell checked, using
29-
link:http://aspell.net[Aspell], both interactively (using
30-
'make spellcheck-interactive') and automatically in Buildbot (using
31-
'make spellcheck').
29+
link:http://aspell.net[Aspell], both interactively (using
30+
'make spellcheck-interactive') and automatically in Buildbot (using
31+
'make spellcheck').
3232

33-
NOTE: A NUT dictionary is also available (docs/nut.dict), providing a
34-
glossary of terms related to power devices and management, as well as
35-
partial terms, technical jargon and author names.
33+
NOTE: A NUT dictionary is also available (as `docs/nut.dict` in NUT sources),
34+
providing a glossary of terms related to power devices and management, as well
35+
as partial terms, technical jargon and author names.
3636

3737
Source code
38-
-----------
38+
~~~~~~~~~~~
3939

4040
Use of standards
41-
~~~~~~~~~~~~~~~~
41+
^^^^^^^^^^^^^^^^
4242

4343
NUT promotes and uses many standards, such as:
4444

@@ -54,12 +54,12 @@ NUT promotes and uses many standards, such as:
5454
* the TCP Wrappers library.
5555

5656
QA tools and metrics
57-
~~~~~~~~~~~~~~~~~~~~
57+
^^^^^^^^^^^^^^^^^^^^
5858

5959
NUT's quality is constantly monitored using many tools, like:
6060

61-
- a Revision Control System (link:https://github.com/networkupstools/nut[Git]) to
62-
track development and ease regression fixes.
61+
- a Revision Control System (link:https://github.com/networkupstools/nut[Git])
62+
to track development and ease regression fixes.
6363

6464
////////////////////////////////////////////////////////////////////////////////
6565
Any modification on the NUT source
@@ -140,13 +140,13 @@ It installs NUT packages, configures it with the dummy-ups driver, changes
140140
provides metrics on NUT source code base and activity.
141141

142142
Runtime quality
143-
~~~~~~~~~~~~~~~
143+
^^^^^^^^^^^^^^^
144144

145145
- NUT provides many link:user-manual.html#NUT_Security[security features] to
146-
ensure a maximum runtime security level.
146+
ensure a maximum runtime security level.
147147

148148
- Packages use several link:http://wiki.debian.org/Hardening[Hardening methods]
149-
to protect NUT binaries.
149+
to protect NUT binaries.
150150

151151
////////////////////////////////////////////////////////////////////////////////
152152
FIXME (POST):

docs/qa-guide.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ developer guide or user manual. Most of this information can be applied to
1717
both automated testing environments and local development workflows.
1818

1919
[[nut-qa]]
20-
include::nut-qa.txt[leveloffset=+1]
20+
include::nut-qa.txt[]
2121

2222
Code and recipe analysis
2323
------------------------

0 commit comments

Comments
 (0)