search

kubernetes-sigs / reference-docs

Tools to build reference documentation for Kubernetes APIs and CLIs.
Apache License 2.0
87 stars 102 forks source link

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

Closed JuliaMongo closed 4 months ago

JuliaMongo commented 1 year ago

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: https://github.com/kubernetes/website/issues/38033

@tengqm

tengqm commented 1 year ago

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.

sftim commented 1 year ago

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.

k8s-triage-robot commented 6 months ago

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

k8s-triage-robot commented 5 months ago

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

k8s-triage-robot commented 4 months ago

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-ci-robot commented 4 months ago

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to [this](https://github.com/kubernetes-sigs/reference-docs/issues/319#issuecomment-2017620578): >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/stale` is applied >- After 30d of inactivity since `lifecycle/stale` was applied, `lifecycle/rotten` is applied >- After 30d of inactivity since `lifecycle/rotten` was 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][1] > >Please send feedback to sig-contributor-experience at [kubernetes/community](https://github.com/kubernetes/community). > >/close not-planned > >[1]: https://www.kubernetes.dev/docs/guide/issue-triage/ Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.