Updates for Attachments Feature, making some info more easily availab…

…le, some small terminology changes. (#357)

docs/_build/html/_sources/installation-and-setup/installation-and-setup.rst.txt

@@ -35,6 +35,11 @@ Setup Options
 
 STIG Manager requires Node.js 14+, Keycloak, and a MySQL Database. It is configured using :ref:`Environment Variables`, and can be deployed as a container from the image provided on Docker Hub or directly from source code.  
 
+Quick Start Orchestration with Docker Compose
+-------------------------------------------------
+
+To quickly establish a demonstration instance of STIG Manager, follow the `Quick Start Orchestration instructions on Docker Hub. <https://hub.docker.com/r/nuwcdivnpt/stig-manager>`_
+
 
 Container Deployment with Docker Desktop
 -------------------------------------------------

docs/_build/html/_sources/user-guide/user-guide.rst.txt

@@ -214,7 +214,7 @@ Double-click on any part of the Review Evaluation for an Asset to change them.
 
 Resources Panel
 -------------------
-This Panel provides access to the Feedback, Metadata, and History tabs.
+This Panel provides access to the Feedback, Attachments, and Log tabs.
 
 Feedback 
 ~~~~~~~~~~~~~~~~~
@@ -225,13 +225,15 @@ If Owner
 If the User is an Owner of the Collection, they will also have the option to Accept or Reject reviews.
 Reviews can be Accepted with the button at the top of the Reviews Panel, or Rejected with the Feedback function at the bottom of this workspace.
 
-Metadata Tab
-~~~~~~~~~~~~~~~~~~~~~
-The Metadata panel provides additional information about the selected Asset and Review.
 
-History Tab
+Attachments tab
+~~~~~~~~~~~~~~~~~
+The Attachments tab allows Reviewers to attach images that support their assessment to their Review. Hover over a specific attachment to see buttons for viewing or deleting that attachment. The "Attach Image..." button becomes available once there is an Evaluation Result for the Review. Support for additional file formats may be added if `Feature Requests <https://github.com/cd-rite/stig-manager/issues/new/choose>`_ are submitted. 
+
+
+Log Tab
 ~~~~~~~~~~~~~~~~~~~~
-The History Panel displays a record of the Review as it has changed over time.
+The Log Panel displays a record of the Review as it has changed over time.
 
 ================================
 
@@ -242,7 +244,7 @@ The History Panel displays a record of the Review as it has changed over time.
 
 Asset Review Workspace
 ====================================
-The Asset Review Workspace allows you to view and modify all the Reviews for a specific STIG on the selected Asset. It also presents useful information such as the Reviews for the same Rule on other Assets, the Review's History, and Feedback.
+The Asset Review Workspace allows you to view and modify all the Reviews for a specific STIG on the selected Asset. It also presents useful information such as the Reviews for the same Rule on other Assets, the Review's Log, and Feedback.
 Users can also import results from .ckl or XCCDF formats, and export their results as .ckl checklists.
 
 .. thumbnail:: /assets/images/asset-review.png
@@ -284,6 +286,21 @@ Review Resources Panel
 ------------------------
 This Panel provides resources that may be useful in performing the Rule's Evaluation.
 
+Attachments tab
+~~~~~~~~~~~~~~~~~
+The Attachments tab allows Reviewers to attach images that support their assessment to their Review. Hover over a specific attachment to see buttons for viewing or deleting that attachment. The "Attach Image..." button becomes available once there is an Evaluation Result for the Review. Support for additional file formats may be added if `Feature Requests <https://github.com/cd-rite/stig-manager/issues/new/choose>`_ are submitted. 
+
+.. thumbnail:: /assets/images/attachments-hover-crop.png
+      :width: 25% 
+      :show_caption: True
+      :title: Attachments Tab
+
+.. thumbnail:: /assets/images/attachments-preview-crop.png
+      :width: 25% 
+      :show_caption: True
+      :title: Attachment Preview
+
+|
 
 Other Assets tab
 ~~~~~~~~~~~~~~~~~
@@ -294,9 +311,9 @@ Feedback tab
 ~~~~~~~~~~~~~~~~~~
 If this Review has been Rejected, Feedback provided by the Collection Owner is displayed here.
 
-History tab
+Log tab
 ~~~~~~~~~~~~~~~~~
-This History tab displays how this Review has changed over time.
+This Log tab displays how this Review has changed over time.
 
 
 Review Panel

docs/_build/html/features/common-tasks.html

@@ -221,12 +221,12 @@ <h1>Accept and Reject STIG Reviews<a class="headerlink" href="#accept-and-reject
 <div class="section" id="analyze-findings-and-generate-a-poam">
 <h1>Analyze Findings and Generate a POAM<a class="headerlink" href="#analyze-findings-and-generate-a-poam" title="Permalink to this headline">¶</a></h1>
 <p>The Findings Report provides a roll-up of every “Open” Evaluation in a Collection, and allows you to drill down into the contributing Asset Reviews.  A POA&amp;M-style spreadsheet of these Findings can also be exported.</p>
-<p>Check the User Guide for more information about the <a class="reference internal" href="../user-guide/user-guide.html#id6"><span class="std std-ref">Findings Report Workspace</span></a>.</p>
+<p>Check the User Guide for more information about the <a class="reference internal" href="../user-guide/user-guide.html#id8"><span class="std std-ref">Findings Report Workspace</span></a>.</p>
 </div>
 <div class="section" id="check-evaluation-progress">
 <h1>Check Evaluation Progress<a class="headerlink" href="#check-evaluation-progress" title="Permalink to this headline">¶</a></h1>
-<p>The <a class="reference internal" href="../user-guide/user-guide.html#id7"><span class="std std-ref">Status Report</span></a> allows Users to gauge the work involved and the progress made towards evaluating every Asset and STIG in their Collection.</p>
-<p>The <a class="reference internal" href="../user-guide/user-guide.html#id7"><span class="std std-ref">Status Report</span></a> also tallies the number of “Open” findings and their severity.</p>
+<p>The <a class="reference internal" href="../user-guide/user-guide.html#id9"><span class="std std-ref">Status Report</span></a> allows Users to gauge the work involved and the progress made towards evaluating every Asset and STIG in their Collection.</p>
+<p>The <a class="reference internal" href="../user-guide/user-guide.html#id9"><span class="std std-ref">Status Report</span></a> also tallies the number of “Open” findings and their severity.</p>
 </div>
 <div class="section" id="add-users">
 <h1>Add Users<a class="headerlink" href="#add-users" title="Permalink to this headline">¶</a></h1>

docs/_build/html/installation-and-setup/installation-and-setup.html

@@ -104,9 +104,10 @@
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="#setup-options">1.2. Setup Options</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#container-deployment-with-docker-desktop">1.2.1. Container Deployment with Docker Desktop</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#deployment-from-source-code">1.2.2. Deployment from Source Code</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#common-configuration-variables">1.2.3. Common Configuration Variables</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#quick-start-orchestration-with-docker-compose">1.2.1. Quick Start Orchestration with Docker Compose</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#container-deployment-with-docker-desktop">1.2.2. Container Deployment with Docker Desktop</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#deployment-from-source-code">1.2.3. Deployment from Source Code</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#common-configuration-variables">1.2.4. Common Configuration Variables</a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="#additional-suggested-configuration">1.3. Additional Suggested Configuration</a><ul>
@@ -255,15 +256,19 @@ <h3><span class="section-number">1.1.2. </span>Client<a class="headerlink" href=
 <div class="section" id="setup-options">
 <h2><span class="section-number">1.2. </span>Setup Options<a class="headerlink" href="#setup-options" title="Permalink to this headline">¶</a></h2>
 <p>STIG Manager requires Node.js 14+, Keycloak, and a MySQL Database. It is configured using <a class="reference internal" href="environment-variables.html#environment-variables"><span class="std std-ref">Environment Variables</span></a>, and can be deployed as a container from the image provided on Docker Hub or directly from source code.</p>
+<div class="section" id="quick-start-orchestration-with-docker-compose">
+<h3><span class="section-number">1.2.1. </span>Quick Start Orchestration with Docker Compose<a class="headerlink" href="#quick-start-orchestration-with-docker-compose" title="Permalink to this headline">¶</a></h3>
+<p>To quickly establish a demonstration instance of STIG Manager, follow the <a class="reference external" href="https://hub.docker.com/r/nuwcdivnpt/stig-manager">Quick Start Orchestration instructions on Docker Hub.</a></p>
+</div>
 <div class="section" id="container-deployment-with-docker-desktop">
-<h3><span class="section-number">1.2.1. </span>Container Deployment with Docker Desktop<a class="headerlink" href="#container-deployment-with-docker-desktop" title="Permalink to this headline">¶</a></h3>
+<h3><span class="section-number">1.2.2. </span>Container Deployment with Docker Desktop<a class="headerlink" href="#container-deployment-with-docker-desktop" title="Permalink to this headline">¶</a></h3>
 <p>Using the STIG Manager container image is the recommended way to deploy the app. These instructions specify a Docker Desktop deployment, but the app will run just as well in a Kubernetes or other orchestration environment. Using this deployment approach satisfies the application’s NodeJS requirement.</p>
 <div class="section" id="requirements">
-<h4><span class="section-number">1.2.1.1. </span>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h4>
+<h4><span class="section-number">1.2.2.1. </span>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h4>
 <p><a class="reference external" href="https://www.docker.com/get-started">Docker</a></p>
 </div>
 <div class="section" id="procedure">
-<h4><span class="section-number">1.2.1.2. </span>Procedure<a class="headerlink" href="#procedure" title="Permalink to this headline">¶</a></h4>
+<h4><span class="section-number">1.2.2.2. </span>Procedure<a class="headerlink" href="#procedure" title="Permalink to this headline">¶</a></h4>
 <ol class="arabic">
 <li><p>Install Docker</p></li>
 <li><p>Install and configure the Authentication and Database requirements. Sample configuration instructions for these requirements can be found here:</p>
@@ -298,17 +303,17 @@ <h4><span class="section-number">1.2.1.2. </span>Procedure<a class="headerlink"
 </div>
 </div>
 <div class="section" id="deployment-from-source-code">
-<h3><span class="section-number">1.2.2. </span>Deployment from Source Code<a class="headerlink" href="#deployment-from-source-code" title="Permalink to this headline">¶</a></h3>
+<h3><span class="section-number">1.2.3. </span>Deployment from Source Code<a class="headerlink" href="#deployment-from-source-code" title="Permalink to this headline">¶</a></h3>
 <p>STIG Manager can be deployed from source if the proper Node.js runtime is provided. These instructions relate to a Windows deployment, but the app will run just as well wherever Node.JS is available.</p>
 <div class="section" id="id1">
-<h4><span class="section-number">1.2.2.1. </span>Requirements<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
+<h4><span class="section-number">1.2.3.1. </span>Requirements<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
 <ul class="simple">
 <li><p><a class="reference external" href="https://nodejs.org/en/">Node.js 14.15+</a></p></li>
 <li><p><a class="reference external" href="https://git-scm.com/downloads">git</a> <em>(recommended)</em></p></li>
 </ul>
 </div>
 <div class="section" id="id2">
-<h4><span class="section-number">1.2.2.2. </span>Procedure<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4>
+<h4><span class="section-number">1.2.3.2. </span>Procedure<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4>
 <ol class="arabic">
 <li><p>Install Node.js</p></li>
 <li><p>Install and configure the Authentication and Database requirements. Sample configuration instructions for these requirements can be found here:</p>
@@ -335,7 +340,7 @@ <h4><span class="section-number">1.2.2.2. </span>Procedure<a class="headerlink"
 </div>
 </div>
 <div class="section" id="common-configuration-variables">
-<h3><span class="section-number">1.2.3. </span>Common Configuration Variables<a class="headerlink" href="#common-configuration-variables" title="Permalink to this headline">¶</a></h3>
+<h3><span class="section-number">1.2.4. </span>Common Configuration Variables<a class="headerlink" href="#common-configuration-variables" title="Permalink to this headline">¶</a></h3>
 <p>It is likely you will have to set at least some of these Environment Variables, but check the full <a class="reference internal" href="environment-variables.html#environment-variables"><span class="std std-ref">Environment Variables</span></a> reference for the full list:</p>
 <blockquote>
 <div><ul class="simple">

docs/_build/html/user-guide/index.html

@@ -220,7 +220,7 @@
 <li class="toctree-l2"><a class="reference internal" href="user-guide.html#collection-review-workspace">2.4. Collection Review Workspace</a></li>
 <li class="toctree-l2"><a class="reference internal" href="user-guide.html#asset-review-workspace">2.5. Asset Review Workspace</a></li>
 <li class="toctree-l2"><a class="reference internal" href="user-guide.html#findings-report-workspace">2.6. Findings Report Workspace</a></li>
-<li class="toctree-l2"><a class="reference internal" href="user-guide.html#id7">2.7. Status Report</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-guide.html#id9">2.7. Status Report</a></li>
 <li class="toctree-l2"><a class="reference internal" href="user-guide.html#collection-management-workspace">2.8. Collection Management Workspace</a></li>
 <li class="toctree-l2"><a class="reference internal" href="user-guide.html#a-note-on-ckl-processing">2.9. A Note on .CKL Processing</a></li>
 </ul>