DDR updates (#1)

BrianSipos · web-flow · commit 763a09124eff · 2023-08-30T11:54:00.000-04:00
* Fix typo in project name

* Updating references to conform with MGSS templates

* Fixing reference formatting
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -2,7 +2,7 @@
 ## Copyright (c) 2023 The Johns Hopkins University Applied Physics
 ## Laboratory LLC.
 ##
-## This file is part of the Asynchronous Network Managment System (ANMS).
+## 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.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -2,7 +2,7 @@
 ## Copyright (c) 2023 The Johns Hopkins University Applied Physics
 ## Laboratory LLC.
 ##
-## This file is part of the Asynchronous Network Managment System (ANMS).
+## 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.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,7 +2,7 @@
 Copyright (c) 2023 The Johns Hopkins University Applied Physics
 Laboratory LLC.
 
-This file is part of the Asynchronous Network Managment System (ANMS).
+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.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 Copyright (c) 2023 The Johns Hopkins University Applied Physics
 Laboratory LLC.
 
-This file is part of the Asynchronous Network Managment System (ANMS).
+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.
@@ -21,7 +21,7 @@ subcontract 1658085.
 -->
 # ANMS Documentation
 
-This repository contains user and maintenance manuals for the Asynchronous Network Managment System (ANMS).
+This repository contains user and maintenance manuals for the Asynchronous Network Management System (ANMS).
 
 It is written with [AsciiDoc](https://asciidoc.org/) and intended for PDF and HTML publication formats.
 
diff --git a/build.sh b/build.sh
@@ -3,7 +3,7 @@
 ## Copyright (c) 2023 The Johns Hopkins University Applied Physics
 ## Laboratory LLC.
 ##
-## This file is part of the Asynchronous Network Managment System (ANMS).
+## 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.
diff --git a/license.tmpl b/license.tmpl
@@ -1,7 +1,7 @@
 Copyright (c) ${years} The Johns Hopkins University Applied Physics
 Laboratory LLC.
 
-This file is part of the Asynchronous Network Managment System (ANMS).
+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.
diff --git a/product-guide/CMakeLists.txt b/product-guide/CMakeLists.txt
@@ -2,7 +2,7 @@
 Copyright (c) 2023 The Johns Hopkins University Applied Physics
 Laboratory LLC.
 
-This file is part of the Asynchronous Network Managment System (ANMS).
+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.
diff --git a/product-guide/docinfo.xml.in b/product-guide/docinfo.xml.in
@@ -1,4 +1,4 @@
-<subtitle>DOC-005539, Prepared by The Johns Hopkins Applied Physics Laboratory</subtitle>
+<subtitle>DOC-005444, Prepared by The Johns Hopkins Applied Physics Laboratory</subtitle>
 <!-- <edition>@PROJECT_VERSION@</edition> -->
 <author>
   <orgname>
@@ -12,7 +12,7 @@
 <legalnotice>
   <title>License</title>
   <simpara>
-This document is part of the Asynchronous Network Managment System (ANMS).
+This document is part of the Asynchronous Network Management System (ANMS).
   </simpara>
   <simpara>
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -34,9 +34,9 @@ subcontract 1658085.
 <revhistory>
   <revision>
     <revnumber>Initial</revnumber>
-    <date>21 August 2023</date>
+    <date>30 August 2023</date>
     <revdescription>
-      Initial issue of document.
+      Initial issue of document for ANMS v1.0
     </revdescription>
   </revision>
 </revhistory>
diff --git a/product-guide/manual.adoc b/product-guide/manual.adoc
@@ -2,7 +2,7 @@
 Copyright (c) ${years} The Johns Hopkins University Applied Physics
 Laboratory LLC.
 
-This file is part of the Asynchronous Network Managment System (ANMS).
+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.
@@ -30,7 +30,7 @@ subcontract 1658085.
 [preface]
 == Introduction
 
-This Product Guide provides architectural and maintenance details about the Asynchronous Network Managment System (ANMS), which is part of the Advanced Multi Mission Operations System (AMMOS) suite of tools.
+This Product Guide provides architectural and maintenance details about the Asynchronous Network Management System (ANMS), which is part of the Advanced Multi Mission Operations System (AMMOS) suite of tools.
 
 === Identification
 
@@ -82,6 +82,52 @@ Internet Protocol (IP)::
 The network protocol used for inter-container communication and for BP convergence layer messaging with AMP Agents.
 
 
+=== References
+
+.Applicable JPL Rules Documents
+[%header,width=100%,cols="<.<3,>.<1"]
+|===
+|Title
+|Document Number
+
+|Software Development[[jpl-sd,SD]]
+|57653 rev 10
+
+|===
+
+
+.Applicable MGSS Documents
+[%header,width=100%,cols="<.<3,>.<1"]
+|===
+|Title
+|Document Number
+
+|MGSS Implementation and Maintenance Task Requirements[[mimtar,MIMTaR]]
+|DOC-001819 ref F
+
+|ANMS User Guide[[anms-user-guide,ANMS User Guide]]
+|DOC-005443
+
+|===
+
+.Applicable Other Documents
+[%header,width=100%,cols="<.<3,>.<1"]
+|===
+|Title
+|Reference
+
+|Installing Puppet[[puppet-agent]]
+|https://www.puppet.com/docs/puppet/7/install_puppet.html[puppet-agent]
+
+|Installing Bolt[[puppet-bolt]]
+|https://www.puppet.com/docs/bolt/latest/bolt_installing.html#install-bolt-on-rhel[puppet-bolt]
+
+|Using SELinux[[rhel8-selinux]]
+|https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/pdf/using_selinux/red_hat_enterprise_linux-8-using_selinux-en-us.pdf[rhel8-selinux]
+
+|===
+
+
 == ANMS Architecture
 
 The ANMS is designed with a microservice architecture using containers for isolation and network protocols to communicate between services.
@@ -588,17 +634,5 @@ Add the following line to the Puppet common.yaml file, typically found at `+pupp
 selinux::mode: permissive
 ----
 
-
-
-
-
-[bibliography]
-== References
-[bibliography]
-* [[[anms-user-guide,ANMS User Guide]]] "Asynchronous Network Management System User Guide," JHU/APL
-* [[[puppet-agent]]] Puppet, "Installing Puppet," 2023. Available at https://www.puppet.com/docs/puppet/7/install_puppet.html
-* [[[puppet-bolt]]] Puppet, "Installing Bolt," 2023. Available at https://www.puppet.com/docs/bolt/latest/bolt_installing.html#install-bolt-on-rhel
-* [[[rhel8-selinux,Using SELinux]]] RedHat, "Using SELinux", 7 Feb 2023. Available at https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/pdf/using_selinux/red_hat_enterprise_linux-8-using_selinux-en-us.pdf
-
 [index]
 == Index
diff --git a/product-guide/pdf-opts.xsl b/product-guide/pdf-opts.xsl
@@ -2,6 +2,7 @@
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
   <xsl:param name="doc.collab.show">0</xsl:param>
   <xsl:param name="latex.output.revhistory">1</xsl:param>
+  <xsl:param name="preface.tocdepth">2</xsl:param>
 
   <xsl:param name="qanda.defaultlabel">none</xsl:param>
   <xsl:param name="bibliography.numbered">0</xsl:param>
diff --git a/product-guide/xhtml-opts.xsl b/product-guide/xhtml-opts.xsl
@@ -2,10 +2,11 @@
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
   <!-- use system resolver for this URL -->
   <xsl:import href="http://docbook.sourceforge.net/release/xsl-ns/current/xhtml5/docbook.xsl"/>
-  
+
   <xsl:param name="doc.collab.show">0</xsl:param>
   <xsl:param name="section.autolabel">1</xsl:param>
   <xsl:param name="section.label.includes.component.label">1</xsl:param>
+  <xsl:param name="preface.tocdepth">2</xsl:param>
   <xsl:param name="generate.toc">
 book      toc,title,figure,table,example,equation
   </xsl:param>
diff --git a/user-guide/CMakeLists.txt b/user-guide/CMakeLists.txt
@@ -2,7 +2,7 @@
 Copyright (c) 2023 The Johns Hopkins University Applied Physics
 Laboratory LLC.
 
-This file is part of the Asynchronous Network Managment System (ANMS).
+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.
diff --git a/user-guide/docinfo.xml.in b/user-guide/docinfo.xml.in
@@ -1,4 +1,4 @@
-<subtitle>DOC-005540, Prepared by The Johns Hopkins Applied Physics Laboratory</subtitle>
+<subtitle>DOC-005443, Prepared by The Johns Hopkins Applied Physics Laboratory</subtitle>
 <!-- <edition>@PROJECT_VERSION@</edition> -->
 <author>
   <orgname>
@@ -12,7 +12,7 @@
 <legalnotice>
   <title>License</title>
   <simpara>
-This document is part of the Asynchronous Network Managment System (ANMS).
+This document is part of the Asynchronous Network Management System (ANMS).
   </simpara>
   <simpara>
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -34,9 +34,9 @@ subcontract 1658085.
 <revhistory>
   <revision>
     <revnumber>Initial</revnumber>
-    <date>21 August 2023</date>
+    <date>30 August 2023</date>
     <revdescription>
-      Initial issue of document.
+      Initial issue of document for ANMS v1.0
     </revdescription>
   </revision>
 </revhistory>
diff --git a/user-guide/manual.adoc b/user-guide/manual.adoc
@@ -91,6 +91,52 @@ Choose:::
 Selecting an item from a drop-down list of available options.
 
 
+=== References
+
+.Applicable JPL Rules Documents
+[%header,width=100%,cols="<.<3,>.<1"]
+|===
+|Title
+|Document Number
+
+|Software Development[[jpl-sd,SD]]
+|57653 rev 10
+
+|===
+
+
+.Applicable MGSS Documents
+[%header,width=100%,cols="<.<3,>.<1"]
+|===
+|Title
+|Document Number
+
+|MGSS Implementation and Maintenance Task Requirements[[mimtar,MIMTaR]]
+|DOC-001819 ref F
+
+|ANMS Product Guide[[anms-product-guide,ANMS Product Guide]]
+|DOC-005444
+
+|===
+
+.Applicable Other Documents
+[%header,width=100%,cols="<.<3,>.<1"]
+|===
+|Title
+|Reference
+
+|Grafana Documentation[[grafana-docs]]
+|https://grafana.com/docs/[grafana-docs]
+
+|Grafana Dashboard Documentation[[grafana-dashboard]]
+|https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/[grafana-dashboard]
+
+|Grafana Panels Documentation[[grafana-panels]]
+|https://grafana.com/docs/grafana/latest/panels-visualizations/[grafana-panels]
+
+|===
+
+
 == User Interface
 
 The following section provides an overview of the ANMS User Interface, organized by the capabilities provided by each of the tabs - Monitor, Agents, Build, Status, ADMs - shown at the top of the ANMS display. 
@@ -373,7 +419,7 @@ If the chosen ARI has parameters, input boxes will be provided for each required
 .ARI Parameter Input
 image::images/simple-ari-param.png[]
 
-ARIs with complex parameters include additional guidance for populating these required fields. For instance, an ARI Collection (AC) builder is provided for ARIs requiring an AC parameter, as shown in <<fig-ari-parms>>. The left side of the screen allows a user to search for the ARI they want to add to the AC and the right-hand side of the screen displays the selected ARI(s). 
+ARIs with complex parameters include additional guidance for populating these required fields. For instance, an ARI Collection (AC) builder is provided for ARIs requiring an AC parameter, as shown in <<fig-ari-params>>. The left side of the screen allows a user to search for the ARI they want to add to the AC and the right-hand side of the screen displays the selected ARI(s). 
 
 [#fig-ari-params]
 .Sample ARI with an AC Parameter
@@ -496,7 +542,7 @@ Selecting the "Get ADMs" button, a user can refresh the table of supported ADMs.
 .Supported ADMs
 image::images/adms-table.png[]
 
-== Downlaoding ADMs
+==== Downlaoding ADMs
 
 Selecting an ADM's name will download the associated JSON file.
 
@@ -1055,16 +1101,5 @@ If this restart does not resolve the issue, check `nginx.conf` in the root of th
 Ensure that `anms-ui` or `localhost` are set to port `80` and the hostname is correct.
 
 
-[bibliography]
-== References
-[bibliography]
-* [[[anms-product-guide,ANMS Product Guide]]] "Asynchronous Network Management System Product Guide," JHU/APL
-
-* [[[grafana-docs]]] https://grafana.com/docs/ 
-
-* [[[grafana-dashboard]]] https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/
-
-* [[[grafana-panels] https://grafana.com/docs/grafana/latest/panels-visualizations/
-
 [index]
 == Index
diff --git a/user-guide/pdf-opts.xsl b/user-guide/pdf-opts.xsl
@@ -2,6 +2,7 @@
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
   <xsl:param name="doc.collab.show">0</xsl:param>
   <xsl:param name="latex.output.revhistory">1</xsl:param>
+  <xsl:param name="preface.tocdepth">2</xsl:param>
 
   <xsl:param name="qanda.defaultlabel">none</xsl:param>
   <xsl:param name="bibliography.numbered">0</xsl:param>
diff --git a/user-guide/xhtml-opts.xsl b/user-guide/xhtml-opts.xsl
@@ -6,6 +6,7 @@
   <xsl:param name="doc.collab.show">0</xsl:param>
   <xsl:param name="section.autolabel">1</xsl:param>
   <xsl:param name="section.label.includes.component.label">1</xsl:param>
+  <xsl:param name="preface.tocdepth">2</xsl:param>
   <xsl:param name="generate.toc">
 book      toc,title,figure,table,example,equation
   </xsl:param>
