From 0a43286f3989c9e985e29a58cb3bfc46b3c4011a Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Tue, 31 Oct 2023 09:44:04 -0400 Subject: [PATCH] update auto_module docs based on feedback (#882) update auto_module docs based on feedback --------- Co-authored-by: Travis Ravert --- source/how-tos/app-development/interactive/form.rst | 11 +++++++++++ source/reference/files/ondemand-d-ymls.rst | 10 +++++++--- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/source/how-tos/app-development/interactive/form.rst b/source/how-tos/app-development/interactive/form.rst index ddebbd831..cf1e7726e 100644 --- a/source/how-tos/app-development/interactive/form.rst +++ b/source/how-tos/app-development/interactive/form.rst @@ -213,6 +213,17 @@ auto_modules_ 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 ` diff --git a/source/reference/files/ondemand-d-ymls.rst b/source/reference/files/ondemand-d-ymls.rst index c3e311066..643bc1612 100644 --- a/source/reference/files/ondemand-d-ymls.rst +++ b/source/reference/files/ondemand-d-ymls.rst @@ -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``