search

jupyterhub / kubespawner

Kubernetes spawner for JupyterHub
https://jupyterhub-kubespawner.readthedocs.io
BSD 3-Clause "New" or "Revised" License
531 stars 299 forks source link

Doc blocks contain dead links to kubernetes API v1.20 #794

Closed acjbrouwer closed 7 months ago

acjbrouwer commented 9 months ago

Doc blocks contain dead links to kubernetes API v1.20

For example the dict and help for extra_pod_config as defined in spawner.py at line 1281 links to https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#<something something> as is the case for a few other bits of documentation throughout the repo. The target page is no longer extant.

How to reproduce

  1. Go to the extra_pod_config documentation
  2. Click on the link https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#podspec-v1-core
  3. ⇒ 404 Page not found
welcome[bot] commented 9 months ago

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively. welcome You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! :wave:
Welcome to the Jupyter community! :tada:

manics commented 9 months ago

I think we just need to replace v1.20 with a more recent version like v1.26. I'm surprised Kubernetes don't keep their old API docs though, especially since the version is part of the URL so there are no conflicts.

consideRatio commented 9 months ago

Go for k8s 1.28 if updating this, its the latest