jupyterhub / batchspawner

Custom Spawner for Jupyterhub to start servers in batch scheduled systems
BSD 3-Clause "New" or "Revised" License
190 stars 134 forks source link

README should not steer new users to overriding submit script template #232

Open mbmilligan opened 2 years ago

mbmilligan commented 2 years ago

The current example configuration code in the README steers new users in an unhelpful direction:

https://github.com/jupyterhub/batchspawner/blob/f4659678061dacf5837fb15ce340230dca18f3ca/README.md?plain=1#L84-L93

If copied, this sample overrides the template script provided with the class, losing features that are implemented with template logic. The sample code should be replaced with one that uses the provided configuration variables (req_* etc) in accordance with recommended practice.