search

jupyterhub / jupyterhub-idle-culler

JupyterHub service to cull idle servers and users
Other
101 stars 37 forks source link

Minor tweaks to the readme #34

Closed consideRatio closed 2 years ago

consideRatio commented 2 years ago

Updated PR description

This PR makes some minor tweaks to the README file that I think improved it slightly.

  1. servers -> delete:servers scope
  2. --cull-admin-users flag listed
  3. Single quotes transformed to double quotes in example configuration to be black compliant
  4. Referenced role name idle-culler and referenced service name cull-idle have been renamed to jupyterhub-idle-culler-service and jupyterhub-idle-culler-role.
  5. Some other small tweaks in text were attempted towards improved readability

Outdated PR description

I note that read:hub is required, and I think we only need the delete:servers rather than read:servers but would love a confirmation on this idea.

Note that the reason we need read:hub is because we access the /hub/api/info endpoint for a version check of the jupyterhub we work against.

https://github.com/jupyterhub/jupyterhub-idle-culler/blob/ae59078ccf3f929702d9833b6b9e644dae0e191d/jupyterhub_idle_culler/__init__.py#L160-L167

Related

https://github.com/jupyterhub/zero-to-jupyterhub-k8s/pull/2434

consideRatio commented 2 years ago

Woops need to make some refinements to the associated text.

consideRatio commented 2 years ago

I suggest we go for a 1.2.1 release with this and #35 in, what do you think @minrk?

minrk commented 2 years ago

@consideRatio go for it!