Update documentation

Blazam-App · Oct 22, 2024 · c81158c · c81158c
1 parent b3236b8
commit c81158c
Show file tree

Hide file tree

Showing 31 changed files with 1,838 additions and 122 deletions.
diff --git a/.vs/docs.blazam.org/v17/.wsuo b/.vs/docs.blazam.org/v17/.wsuo
diff --git a/.vs/slnx.sqlite b/.vs/slnx.sqlite
diff --git a/docs/404.html b/docs/404.html
@@ -761,6 +761,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="/user/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    User Guide
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
 
 
 
@@ -769,10 +789,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
 
 
-          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -783,8 +803,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_6">
             <span class="md-nav__icon md-icon"></span>
             About
           </label>

diff --git a/docs/admin/fields/index.html b/docs/admin/fields/index.html
@@ -850,6 +850,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../../user/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    User Guide
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
 
 
 
@@ -858,10 +878,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
 
 
-          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -872,8 +892,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_6">
             <span class="md-nav__icon md-icon"></span>
             About
           </label>

diff --git a/docs/admin/initialSetup/index.html b/docs/admin/initialSetup/index.html
@@ -784,6 +784,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../../user/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    User Guide
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
 
 
 
@@ -792,10 +812,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
 
 
-          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -806,8 +826,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_6">
             <span class="md-nav__icon md-icon"></span>
             About
           </label>

diff --git a/docs/admin/notifications/index.html b/docs/admin/notifications/index.html
@@ -18,7 +18,7 @@
         <link rel="prev" href="../fields/">
 
 
-        <link rel="next" href="../../license/">
+        <link rel="next" href="../../user/">
 
 
       <link rel="icon" href="../../assets/images/favicon.png">
@@ -850,6 +850,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../../user/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    User Guide
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
 
 
 
@@ -858,10 +878,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
 
 
-          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -872,8 +892,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_6">
             <span class="md-nav__icon md-icon"></span>
             About
           </label>
@@ -1113,13 +1133,13 @@ <h2 id="admin-management">Admin Management</h2>
 
 
 
-          <a href="../../license/" class="md-footer__link md-footer__link--next" aria-label="Next: License">
+          <a href="../../user/" class="md-footer__link md-footer__link--next" aria-label="Next: User Guide">
             <div class="md-footer__title">
               <span class="md-footer__direction">
                 Next
               </span>
               <div class="md-ellipsis">
-                License
+                User Guide
               </div>
             </div>
             <div class="md-footer__button md-icon">

diff --git a/docs/admin/permissions/index.html b/docs/admin/permissions/index.html
@@ -931,6 +931,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../../user/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    User Guide
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
 
 
 
@@ -939,10 +959,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
 
 
-          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -953,8 +973,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_6">
             <span class="md-nav__icon md-icon"></span>
             About
           </label>

diff --git a/docs/admin/settings/application/index.html b/docs/admin/settings/application/index.html
@@ -879,6 +879,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../../../user/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    User Guide
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
 
 
 
@@ -887,10 +907,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
 
 
-          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -901,8 +921,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_6">
             <span class="md-nav__icon md-icon"></span>
             About
           </label>
@@ -1085,17 +1105,25 @@ <h2 id="user-helpdesk-url">User Helpdesk URL</h2>
 </div>
 <p>This is your organizations tech support portal for help buttons within Blazam.</p>
 <h2 id="branding-icon">Branding Icon</h2>
-<p>Upload you organization's logo or other image to use within the app.</p>
+<p>Upload you organization's logo or other image to use within the app. </p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The icons used in Blazam are sent to the browser in a method that
+tells the browser to cache the image for up to 24 hours. This reduces
+traffic between the web server and the database. Keep this in mind when
+changing the Branding Icon.</p>
+</div>
 <h2 id="website-fqdn">Website FQDN</h2>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>Not currently implemented</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Will be used for links within notification emails in an upcoming update</p>
 </div>
-<p>The full domain name of your Blazam instance for use in email notification links.</p>
+<p>The fully qualified domain name of your Blazam instance for use in email notification links.</p>
 <h2 id="ssl-certificate">SSL Certificate</h2>
 <div class="admonition info">
 <p class="admonition-title">Info</p>
-<p>Only available when running Blazam as a service</p>
+<p>Only available when running Blazam as a service. Use IIS Manager to control
+SSL when running under IIS.</p>
 </div>
 <p>Upload an SSL certificate with private key to use for encryption</p>