Zero-to-jupyterhub-k8s: Fix broken links in documentation

Created on 4 Dec 2019 · 4Comments · Source: jupyterhub/zero-to-jupyterhub-k8s

I used a online website service to check our documentation links and if they functioned as they should, and came up with this report: http://website-link-checker.online-domain-tools.com/link/1c23febgtzy0pMUbGj/

@choldgraf and @willingc I've seen you solve link breakage effectively before and I hope to learn from your experience!

Are you aware of a similar tool like that online based tool above that you would recommend for working to ensure documentation links are maintained?
Is it possible for us to setup some redirects with RTD so that external links to our documentation can still arrive correctly even after we reorganize it? Where / how is this done? Ah that became a very easy question to answer myself!
Answer: Yes we can! Here is documentation about it: https://docs.readthedocs.io/en/stable/user-defined-redirects.html. Here is this projects redirects: https://readthedocs.org/dashboard/zero-to-jupyterhub/redirects/

Broken links as of `95fd91f`

Click to show broken links and files

writing output... [  2%] administrator/advanced

(line   34) broken    https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-controllers - Anchor 'ingress-controllers' not found
(line  204) broken    https://zero-to-jupyterhub.readthedocs.io/en/latest/reference.html?highlight=pvc#hub-db-type - Anchor 'hub-db-type' not found

writing output... [  7%] administrator/authentication

(line  145) broken    https://zero-to-jupyterhub.readthedocs.io/en/latest/reference.html#hub-extraconfig - Anchor 'hub-extraconfig' not found

writing output... [ 17%] administrator/optimization

(line   71) broken    https://docs.helm.sh/developing_charts/#hooks - Anchor 'hooks' not found
(line  228) broken    https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-types-of-pods-can-prevent-ca-from-removing-a-node - Anchor 'what-types-of-pods-can-prevent-ca-from-removing-a-node' not found

writing output... [ 21%] administrator/troubleshooting

(line   28) broken    https://github.com/jupyterhub/helm-chart#versions-coupled-to-each-chart-release - Anchor 'versions-coupled-to-each-chart-release' not found
writing output... [ 24%] administrator/upgrading

(line   11) broken    https://groups.google.com/forum/#%21forum/jupyter - Anchor '%21forum/jupyter' not found
(line    6) broken    https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/master/CHANGELOG - 404 Client Error: Not Found for url: https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/master/CHANGELOG
(line   19) broken    https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/master/CHANGELOG - 404 Client Error: Not Found for url: https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/master/CHANGELOG
(line   29) broken    https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/master/CHANGELOG.md#06---ellyse-perry---2017-01-29 - Anchor '06---ellyse-perry---2017-01-29' not found
(line   38) broken    https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/master/CHANGELOG.md#05---hamid-hassan---2017-12-05 - Anchor '05---hamid-hassan---2017-12-05' not found
(line  140) broken    https://github.com/jupyterhub/helm-chart#versions-coupled-to-each-chart-release%3E - Anchor 'versions-coupled-to-each-chart-release%3E' not found

writing output... [ 29%] amazon/step-zero-aws

(line   60) broken    http://169.254.169.254/latest/dynamic/instance-identity - HTTPConnectionPool(host='169.254.169.254', port=80): Max retries exceeded with url: /latest/dynamic/instance-identity (Caused by NewConnectionError('<urllib3.connection.HTTPConnection object at 0x7f69eec52e48>: Failed to establish a new connection: [Errno 101] Network is unreachable'))
(line  157) broken    https://github.com/kubernetes/kops/blob/master/docs/examples/kops-tests-private-net-bastion-host.md#adding-a-bastion-host-to-our-cluster - Anchor 'adding-a-bastion-host-to-our-cluster' not found

writing output... [ 39%] community/tips

(line   24) broken    https://docs.helm.sh/helm/#helm-completion - Anchor 'helm-completion' not found

writing output... [ 51%] customizing/user-environment

(line  263) broken    https://github.com/jupyterhub/nbgitpuller#installation - Anchor 'installation' not found
(line  283) broken    https://github.com/jupyterhub/nbgitpuller#merging-behavior - Anchor 'merging-behavior' not found

writing output... [ 56%] customizing/user-resources

(line  102) broken    https://github.com/NVIDIA/k8s-device-plugin#quick-start - Anchor 'quick-start' not found

writing output... [ 65%] ibm/step-zero-ibm

(line   11) broken    https://kubernetes.io/docs/tutorials/kubernetes-basics/) - 404 Client Error: Not Found for url: https://kubernetes.io/docs/tutorials/kubernetes-basics/)
(line   51) broken    https://kubernetes.io/docs/user-guide/kubectl-overview/) - 404 Client Error: Not Found for url: https://kubernetes.io/docs/user-guide/kubectl-overview/)
(line   14) broken    https://console.bluemix.net/docs/cli/index.html#overview) - Anchor 'overview)' not found
(line   47) broken    https://console.bluemix.net/docs/containers/cs_clusters.html#clusters_cli) - Anchor 'clusters_cli)' not found
(line   82) broken    https://console.bluemix.net/docs/tutorials/scalable-webapp-kubernetes.html#deploy-a-scalable-web-application-on-kubernetes - Anchor 'deploy-a-scalable-web-application-on-kubernetes' not found
(line    6) broken    https://console.bluemix.net/containers-kubernetes/catalog/cluster) - 404 Client Error: Not Found for url: https://cloud.ibm.com/kubernetes/catalog/cluster)
(line   33) broken    https://console.bluemix.net/containers-kubernetes/launch) - 404 Client Error: Not Found for url: https://cloud.ibm.com/kubernetes/launch)
writing output... [ 68%] index

(line   42) broken    https://your-domain-name.com - HTTPSConnectionPool(host='your-domain-name.com', port=443): Max retries exceeded with url: / (Caused by NewConnectionError('<urllib3.connection.VerifiedHTTPSConnection object at 0x7f69eea9a3c8>: Failed to establish a new connection: [Errno -5] No address associated with hostname'))

writing output... [ 78%] reference/glossary

(line   64) broken    https://docs.helm.sh/chart_template_guide/#the-chart-template-developer-s-guide - Anchor 'the-chart-template-developer-s-guide' not found
(line   56) broken    https://docs.helm.sh/developing_charts/#charts - Anchor 'charts' not found
(line   68) broken    https://docs.helm.sh/chart_template_guide/#values-files - Anchor 'values-files' not found

writing output... [ 95%] setup-jupyterhub/setup-helm

(line   27) broken    https://github.com/helm/helm/blob/master/docs/install.md - 404 Client Error: Not Found for url: https://github.com/helm/helm/blob/master/docs/install.md
writing output... [ 97%] setup-jupyterhub/setup-jupyterhub

(line  129) broken    https://github.com/jupyterhub/helm-chart#versions-coupled-to-each-chart-release - Anchor 'versions-coupled-to-each-chart-release' not found


build finished with problems, 4 warnings.
Makefile:29: recipe for target 'linkcheck' failed

Source