Skip to content

Commit

Permalink
update auto_module docs based on feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
johrstrom committed Oct 27, 2023
1 parent 0d0daed commit ba901d7
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
11 changes: 11 additions & 0 deletions source/how-tos/app-development/interactive/form.rst
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``.

Also - hyphens cause issues in templating the script files. So, 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
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

0 comments on commit ba901d7

Please sign in to comment.