docs: fix broken CI badge and outdated links in README#2522
docs: fix broken CI badge and outdated links in README#2522k8s-ci-robot merged 2 commits intokubernetes-client:masterfrom
Conversation
|
Welcome @Pro-Ace-grammer! |
|
/release-note-none |
README.md
Outdated
| [](https://pypi.python.org/pypi/kubernetes) | ||
| [](http://bit.ly/kubernetes-client-capabilities-badge) | ||
| [](http://bit.ly/kubernetes-client-support-badge) | ||
| [](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md) |
There was a problem hiding this comment.
There was a problem hiding this comment.
I replaced the broken bit.ly link because it was returning a 404. I pointed it to the API Conventions as it outlines the standard expectations for client-server interoperability and object metadata. However, if there is a more specific 'Capabilities' matrix or a different internal document you'd prefer I link to, I’m happy to update it!
README.md
Outdated
| [](http://bit.ly/kubernetes-client-capabilities-badge) | ||
| [](http://bit.ly/kubernetes-client-support-badge) | ||
| [](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md) | ||
| [](https://github.com/kubernetes/client-go#compatibility) |
There was a problem hiding this comment.
why pointing to https://github.com/kubernetes/client-go#compatibility ?
There was a problem hiding this comment.
Here too I replaced the broken bit.ly link which was returning a 404. I pointed it to the client-go compatibility section as a general reference for Kubernetes client support levels. However, if there is a more appropriate Python-specific compatibility document or a table within this repository you'd prefer I link to, please let me know and I will update it immediately.
There was a problem hiding this comment.
There was a problem hiding this comment.
Thank you for the guidance! I have updated both the 'Client Capabilities' and 'Client Support Level' links to point to the suggested design-proposals-archive link.
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Pro-Ace-grammer, yliaog The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR updates the README.md to fix multiple broken links that were providing a poor user experience.
The CI status badge was pointing to an inactive test.yml file; it now points to the active Kubernetes Python Client - Validation workflow.
Outdated bit.ly links for "Client Capabilities" and "Client Support Level" have been replaced with their current official documentation targets.
Which issue(s) this PR fixes:
Fixes #2516
Special notes:
The badge now correctly renders the "passing" status for the validation workflow.