kubernetes-client
Website Documentation Link Broken
Link to the issue (please include a link to the specific documentation or example): https://kubernetes.readthedocs.io/en/latest/README.html#documentation
Description of the issue (please include outputs or screenshots if possible):
The link leading to the "Generated client’s README file" does not have the .md ending, causing the link to lead to a 404. I'm not sure if this is the correct place to report this issue, but the "Edit on GitHub" button led me to this repository (which also led me to a 404). This possibly might just be because the website hasn't been regenerated in a while, but I have never used this method of documentation so I can't say for sure.
Fixing the documentation on the website can help new users of this library significantly by pointing them to the correct information.
I verified that the building html pages with latest version of the code at 469ef552 resulted in the complete URL (https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md) being hyperlinked over the text "Generated client’s README file" unlike the hosted site where the broken link of (https://github.com/kubernetes-client/python/blob/master/kubernetes/README) is linked to that text.
This only leads me to conclude that the current version of the code is not hosted in the readTheDocs site like @jdholtz suggested. @roycaihw, @yliaog can you please guide me on how to correct this?
This PR https://github.com/kubernetes-client/python/pull/2026 should fix it.
The Kubernetes project currently lacks enough contributors to adequately respond to all issues.
This bot triages un-triaged issues according to the following rules:
- After 90d of inactivity,
lifecycle/staleis applied - After 30d of inactivity since
lifecycle/stalewas applied,lifecycle/rottenis applied - After 30d of inactivity since
lifecycle/rottenwas applied, the issue is closed
You can:
- Mark this issue as fresh with
/remove-lifecycle stale - Close this issue with
/close - Offer to help out with Issue Triage
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.
This bot triages un-triaged issues according to the following rules:
- After 90d of inactivity,
lifecycle/staleis applied - After 30d of inactivity since
lifecycle/stalewas applied,lifecycle/rottenis applied - After 30d of inactivity since
lifecycle/rottenwas applied, the issue is closed
You can:
- Mark this issue as fresh with
/remove-lifecycle rotten - Close this issue with
/close - Offer to help out with Issue Triage
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.
This bot triages issues according to the following rules:
- After 90d of inactivity,
lifecycle/staleis applied - After 30d of inactivity since
lifecycle/stalewas applied,lifecycle/rottenis applied - After 30d of inactivity since
lifecycle/rottenwas applied, the issue is closed
You can:
- Reopen this issue with
/reopen - Mark this issue as fresh with
/remove-lifecycle rotten - Offer to help out with Issue Triage
Please send feedback to sig-contributor-experience at kubernetes/community.
/close not-planned
@k8s-triage-robot: Closing this issue, marking it as "Not Planned".
In response to this:
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.
This bot triages issues according to the following rules:
- After 90d of inactivity,
lifecycle/staleis applied- After 30d of inactivity since
lifecycle/stalewas applied,lifecycle/rottenis applied- After 30d of inactivity since
lifecycle/rottenwas applied, the issue is closedYou can:
- Reopen this issue with
/reopen- Mark this issue as fresh with
/remove-lifecycle rotten- Offer to help out with Issue Triage
Please send feedback to sig-contributor-experience at kubernetes/community.
/close not-planned
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
