Skip to content

Commit

Permalink
add docs on saved settings (#1032)
Browse files Browse the repository at this point in the history
This adds docs on saved settings and updates that to include
the additions made in 4.0.
  • Loading branch information
johrstrom authored Dec 2, 2024
1 parent 4ddaec3 commit ba9b289
Show file tree
Hide file tree
Showing 7 changed files with 97 additions and 0 deletions.
1 change: 1 addition & 0 deletions source/how-tos/app-development/interactive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
63 changes: 63 additions & 0 deletions source/how-tos/app-development/interactive/saved-settings.rst
Original file line number Diff line number Diff line change
@@ -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
Binary file added source/images/bc_saved_settings_edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/bc_saved_settings_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/bc_saved_settings_select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions source/reference/files/ondemand-d-ymls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
11 changes: 11 additions & 0 deletions source/release-notes/v4.0-release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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!
-------
Expand Down Expand Up @@ -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.

0 comments on commit ba9b289

Please sign in to comment.