-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This adds docs on saved settings and updates that to include the additions made in 4.0.
- Loading branch information
Showing
7 changed files
with
97 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 63 additions & 0 deletions
63
source/how-tos/app-development/interactive/saved-settings.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters