OSC / ood-documentation

Documentation for Open OnDemand generated using Sphinx
https://osc.github.io/ood-documentation/latest/
MIT License
8 stars 51 forks source link

Enable Custom Job Submission Rewording #804

Closed Oglopf closed 1 year ago

Oglopf commented 1 year ago

In the docs we have a section on enabling the Interactive Desktop for users, and on page 4 we have the following:

Do not put the [Job Submission (submit.yml.erb)](https://osc.github.io/ood-documentation/latest/how-tos/app-development/interactive/submit.html#app-development-interactive-submit) 
configuration file directly underneath /etc/ood/config/apps/bc_desktop or it will think this an 
Interactive Desktop app. Instead we typically create the directory submit/ underneath and put our 
[Job Submission (submit.yml.erb)](https://osc.github.io/ood-documentation/latest/how-tos/app-development/interactive/submit.html#app-development-interactive-submit) 
configuration files underneath that.

Since this is describing how to setup interactive desktops, it can be hard for the admins to understand that anything in that root app directory is treated as a form which means it's treated as an app. Because of this, you need that submit/ directory to land the submit.yml.erb for OOD to pick this up correctly.

It may be as simple as just remove the "or ood will think this is an Interactive Desktop app" portion which was my own source of confusion reading these.

It may be helpful to also add some entry around this fact that ood will think of those *.ymls as apps only, and how the clusters.d/ and submit/*.yml relate to this.

Oglopf commented 1 year ago

Coming back to this, if we don't already, it may be helpful to also include a diagram of what the file structure for the app should look like in the end as some users are tripped up on creating the submit directory to then store the submit.yml.erb there and not in the app's base directory, which would then treat it as a separate desktop app. This is what the Danger banner is getting at, but this can just call that out more directly.