New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add anchors that would allow linking to items in the generated API reference. Fix search so that it doesn't point to older versions. #319
Comments
I'm afraid the generator cannot be smart enough to add the links. The generator only parse the upstream source code comments (https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/api/core/v1/types.go#L4766-L4773). If you want to improve the description of the field, e.g. adding a link to somewhere, you will need to propose a fix to the kubernetes/kubernetes project. We can then regenerate the reference out of the upstream source code. |
IMO this is the right place to file the issue, but it's going to need a KEP and quite a bit of time to make it happen. |
The Kubernetes project currently lacks enough contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
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:
You can:
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:
You can:
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:
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. |
Please allow linking to items within the generated API reference. For example, we needed a link to publishNotReadyAddresses in the API reference, but couldn't get it.
Also, there is something with the search for this setting. When searching for it, the results that come up point to the 1.21 version of the API reference, which is not the latest.
See this issue please: kubernetes/website#38033
@tengqm
The text was updated successfully, but these errors were encountered: