Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update auto_module docs based on feedback #882

Merged
merged 3 commits into from
Oct 31, 2023
Merged

update auto_module docs based on feedback #882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba901d7
update auto_module docs based on feedback
johrstrom Oct 27, 2023
83270bc
Update source/how-tos/app-development/interactive/form.rst
johrstrom Oct 30, 2023
5ba9599
Update source/reference/files/ondemand-d-ymls.rst
johrstrom Oct 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions source/how-tos/app-development/interactive/form.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,17 @@ auto_modules_<MODULE>
Meaning only versions appropriate to a given cluster will be shown when that
cluster is chosen.

.. note::

The form configuration is case sensitive. So there is a difference between
``auto_modules_R`` and ``auto_modules_r``.

Hyphens cause issues in templating the script files. For example,
a form configuration like ``auto_modules_netcdf-serial`` would need to be
referenced in the ``script.sh.erb`` as ``<%= auto_modules_netcdf_serial %>``
replacing any hyphens (``-``) with underscores ``_``.


auto_groups
This will automatically generate a ``select`` widget populated with a list of the Unix
groups the user is currently in. Administrators can configure :ref:`filter for autogroups <auto_groups_filter>`
Expand Down
10 changes: 7 additions & 3 deletions source/reference/files/ondemand-d-ymls.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,9 +591,13 @@ Configuration Properties
.. _module_file_dir:
.. describe:: module_file_dir (String, null)

Specify a directory where module files per cluster exist. This directory
should have module spider-json output as indicated by the command below.
Open OnDemand will read these files and potentially show them in a from.
Specify a directory where **cluster specific module files** exist. It's important
that there be a file for each cluster because the system can then tie those
modules to that specific cluster.

This directory should have ``module spider-json`` output **for each cluster**
as indicated by the command below. Open OnDemand will read these files and
potentially show them in a from for a cluster called **my_cluster**.

``$LMOD_DIR/spider -o spider-json $MODULEPATH > /some/directory/my_cluster.json``

Expand Down