[ci skip] Autodoc commit for ba9b289.

develop/_sources/how-tos/app-development/interactive.rst.txt

@@ -46,3 +46,4 @@ Each of these files/directories are described below in their respective stage.
    interactive/sub-apps
    interactive/conn-params
    interactive/additional-info
+   interactive/saved-settings

develop/_sources/how-tos/app-development/interactive/saved-settings.rst.txt

@@ -0,0 +1,63 @@
+.. _interactive-app-saved-settings:
+
+Saving interactive application settings
+=======================================
+
+If enabled, users can save and manage saved settings for their
+interactive applications.
+
+Enabling
+--------
+
+This feature is controlled by the :ref:`ondemand.d configuration bc_saved_settings <bc_saved_settings>`.
+Set it to ``true`` to enable this feature.
+
+It is disabled by default.
+
+Demonstration
+-------------
+
+Here's a demonstration of how this feature works and what it will do.
+
+Saving Settings
+...............
+
+When this feature is enabled, users will begin to see this checkbox above
+the ``Launch`` button to save these choices currently in the form.
+
+.. figure:: /images/bc_saved_settings_select.png
+
+Checking this checkbox will open a modal where the user can give these
+settings a name.
+
+Once the name is specified users can ``Launch`` and that will
+save the settings along with launching the job. They can also choose
+to simply save the settings and close.
+
+Using Settings
+..............
+
+When a user has saved settings for a given interactive application,
+they'll now see a dropdown menu to choose those settings. Note that
+when a given saved setting is chosen, the form updates the values
+automatically.
+
+.. figure:: /images/bc_saved_settings_form.png
+
+.. _edit-save-interactive-app-saved-settings:
+
+Editing and deleting settings
+.............................
+
+You may have seen in the image above that there's a new section
+on the left panel entitled ``Saved Settings``.
+
+Clicking on the icons in this panel will open a page much like the
+image below.
+
+Here you can delete the saved setting by pressing the Delete button.
+You can also edit the settings by pressing the pencil icon at the top
+right of the card. You can also submit a job using these settings
+with the play icon.
+
+.. figure:: /images/bc_saved_settings_edit.png

develop/_sources/reference/files/ondemand-d-ymls.rst.txt

@@ -1010,3 +1010,25 @@ Configuration Properties
     .. code-block:: yaml
 
       status_poll_delay: 30000
+
+.. _bc_saved_settings:
+
+.. describe:: bc_saved_settings (Boolean, false)
+
+  Enabled or disable saving batch connect settings.
+  When users fill out a form for an interactive application,
+  they can choose to save those settings to easily reuse later.
+
+  Default
+    Disabled by default.
+
+    .. code-block:: yaml
+
+      bc_saved_settings: false
+
+  Example
+    Enable saving batch connect settings.
+
+    .. code-block:: yaml
+
+      bc_saved_settings: true

develop/_sources/release-notes/v4.0-release-notes.rst.txt

@@ -22,6 +22,7 @@ New Features
 - `Interactive apps can have a text header`_
 - `Remove runtime dependency on SCL`_
 - `XDMoD efficiency widget update`_
+- `Edit and delete interactive application saved settings`_
 
 Thanks!
 -------
@@ -383,3 +384,13 @@ XDMoD efficiency widget update
 
 XDMoD job efficiency panels now show efficiency calculations
 for CPU usage, memory and time.
+
+Edit and delete interactive application saved settings
+......................................................
+
+Since launching saved settings for interactive applications
+in version 3.1, 4.0 now offers the ability to edit and delete
+these saved settings.
+
+See :ref:`edit-save-interactive-app-saved-settings` for more
+details.

develop/how-tos/app-development.html

@@ -233,6 +233,7 @@
 <li class="toctree-l2"><a class="reference internal" href="app-development/interactive/sub-apps.html">Sub-Apps and Reconfiguring exsting apps</a></li>
 <li class="toctree-l2"><a class="reference internal" href="app-development/interactive/conn-params.html">Connection Parameters <code class="docutils literal notranslate"><span class="pre">conn_params</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="app-development/interactive/additional-info.html">Adding Additional Information to the session cards</a></li>
+<li class="toctree-l2"><a class="reference internal" href="app-development/interactive/saved-settings.html">Saving interactive application settings</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="app-development/app-sharing.html">App Sharing</a><ul>

develop/how-tos/app-development/app-sharing.html

@@ -40,7 +40,7 @@
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
     <link rel="next" title="Install Other Interactive Apps" href="../../install-ihpc-apps.html" />
-    <link rel="prev" title="Adding Additional Information to the session cards" href="interactive/additional-info.html" />
+    <link rel="prev" title="Saving interactive application settings" href="interactive/saved-settings.html" />
 
 <script async src="https://www.googletagmanager.com/gtag/js?id=UA-34776817-3"></script>
 <script>
@@ -451,7 +451,7 @@ <h3>Example of Executable Sharing<a class="headerlink" href="#example-of-executa
         <a href="../../install-ihpc-apps.html" class="btn btn-neutral float-right" title="Install Other Interactive Apps" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="interactive/additional-info.html" class="btn btn-neutral float-left" title="Adding Additional Information to the session cards" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="interactive/saved-settings.html" class="btn btn-neutral float-left" title="Saving interactive application settings" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 

develop/how-tos/app-development/interactive.html

@@ -126,6 +126,7 @@
 <li class="toctree-l3"><a class="reference internal" href="interactive/sub-apps.html">Sub-Apps and Reconfiguring exsting apps</a></li>
 <li class="toctree-l3"><a class="reference internal" href="interactive/conn-params.html">Connection Parameters <code class="docutils literal notranslate"><span class="pre">conn_params</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="interactive/additional-info.html">Adding Additional Information to the session cards</a></li>
+<li class="toctree-l3"><a class="reference internal" href="interactive/saved-settings.html">Saving interactive application settings</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="app-sharing.html">App Sharing</a></li>
@@ -331,6 +332,16 @@
 <li class="toctree-l2"><a class="reference internal" href="interactive/additional-info.html#completed-md-html-erb">completed.{md,html}.erb</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="interactive/saved-settings.html">Saving interactive application settings</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="interactive/saved-settings.html#enabling">Enabling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interactive/saved-settings.html#demonstration">Demonstration</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="interactive/saved-settings.html#saving-settings">Saving Settings</a></li>
+<li class="toctree-l3"><a class="reference internal" href="interactive/saved-settings.html#using-settings">Using Settings</a></li>
+<li class="toctree-l3"><a class="reference internal" href="interactive/saved-settings.html#editing-and-deleting-settings">Editing and deleting settings</a></li>
+</ul>
+</li>
+</ul>
+</li>
 </ul>
 </div>
 </div>

develop/how-tos/app-development/interactive/additional-info.html

@@ -39,7 +39,7 @@
   <link rel="stylesheet" href="../../../_static/tabs.css" type="text/css" />
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
-    <link rel="next" title="App Sharing" href="../app-sharing.html" />
+    <link rel="next" title="Saving interactive application settings" href="saved-settings.html" />
     <link rel="prev" title="Connection Parameters conn_params" href="conn-params.html" />
 
 <script async src="https://www.googletagmanager.com/gtag/js?id=UA-34776817-3"></script>
@@ -130,6 +130,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#completed-md-html-erb">completed.{md,html}.erb</a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="saved-settings.html">Saving interactive application settings</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../app-sharing.html">App Sharing</a></li>
@@ -263,7 +264,7 @@
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="../app-sharing.html" class="btn btn-neutral float-right" title="App Sharing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="saved-settings.html" class="btn btn-neutral float-right" title="Saving interactive application settings" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="conn-params.html" class="btn btn-neutral float-left" title="Connection Parameters conn_params" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

develop/how-tos/app-development/interactive/conn-params.html

@@ -129,6 +129,7 @@
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="additional-info.html">Adding Additional Information to the session cards</a></li>
+<li class="toctree-l3"><a class="reference internal" href="saved-settings.html">Saving interactive application settings</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../app-sharing.html">App Sharing</a></li>

develop/how-tos/app-development/interactive/dynamic-form-widgets.html

@@ -134,6 +134,7 @@
 <li class="toctree-l3"><a class="reference internal" href="sub-apps.html">Sub-Apps and Reconfiguring exsting apps</a></li>
 <li class="toctree-l3"><a class="reference internal" href="conn-params.html">Connection Parameters <code class="docutils literal notranslate"><span class="pre">conn_params</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="additional-info.html">Adding Additional Information to the session cards</a></li>
+<li class="toctree-l3"><a class="reference internal" href="saved-settings.html">Saving interactive application settings</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../app-sharing.html">App Sharing</a></li>

develop/how-tos/app-development/interactive/form-widgets.html

@@ -126,6 +126,7 @@
 <li class="toctree-l3"><a class="reference internal" href="sub-apps.html">Sub-Apps and Reconfiguring exsting apps</a></li>
 <li class="toctree-l3"><a class="reference internal" href="conn-params.html">Connection Parameters <code class="docutils literal notranslate"><span class="pre">conn_params</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="additional-info.html">Adding Additional Information to the session cards</a></li>
+<li class="toctree-l3"><a class="reference internal" href="saved-settings.html">Saving interactive application settings</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../app-sharing.html">App Sharing</a></li>

develop/how-tos/app-development/interactive/form.html

@@ -133,6 +133,7 @@
 <li class="toctree-l3"><a class="reference internal" href="sub-apps.html">Sub-Apps and Reconfiguring exsting apps</a></li>
 <li class="toctree-l3"><a class="reference internal" href="conn-params.html">Connection Parameters <code class="docutils literal notranslate"><span class="pre">conn_params</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="additional-info.html">Adding Additional Information to the session cards</a></li>
+<li class="toctree-l3"><a class="reference internal" href="saved-settings.html">Saving interactive application settings</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../app-sharing.html">App Sharing</a></li>

develop/how-tos/app-development/interactive/manifest.html

@@ -126,6 +126,7 @@
 <li class="toctree-l3"><a class="reference internal" href="sub-apps.html">Sub-Apps and Reconfiguring exsting apps</a></li>
 <li class="toctree-l3"><a class="reference internal" href="conn-params.html">Connection Parameters <code class="docutils literal notranslate"><span class="pre">conn_params</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="additional-info.html">Adding Additional Information to the session cards</a></li>
+<li class="toctree-l3"><a class="reference internal" href="saved-settings.html">Saving interactive application settings</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../app-sharing.html">App Sharing</a></li>