community
community copied to clipboard
knative
Support knative.dev/REPO redirect to pkg.go.dev/knative.dev/serving for go packages
right now: knative.dev/serving redirects to pkg.go.dev/knative.dev/serving knative.dev/pkg redirects to pkg.go.dev/knative.dev/pkg
But: https://knative.dev/net-kourier does not forward to https://pkg.go.dev/knative.dev/net-kourier and the same for all other go repos.
Seems like the implementation for serving and pkg is extendible (See https://github.com/knative/docs/pull/5176) - we now added security-guard and it seems to work. We may add other repos as well, either directly to the file as done here or we can maybe externalize the list to allow people to commit to a text file rather than changing the script..
The docs WG are not responsible for documenting how new repos are added to the project, so any changes to the process to ask folks to add these redirects should be discussed with the TOC and added here: https://github.com/knative/community/tree/main/mechanics
AFAIK these Go redirects aren't something the docs WG actively maintains, while they live in our repo because of the website, it should be up to the owners for each of these Go packages to manage these redirects.
I think this should be closed in the docs repo and opened as an issue in the community repo instead.
/transfer-issue community
Transferring this issue to the community repo since it's a process change suggestion/request.
I started https://github.com/knative/docs/pull/4524 trying to get the redirect set up for all repos automatically, and eventually pulled it back to just a couple repos based on review feedback. It should be easy to add net-kourier if you're interested, just update https://github.com/knative/docs/blob/main/tools/redir-gen/main.go#L36. If enough repos are redirected it might be worth flipping it from an allowlist to a blocklist.
Going to close this off as there's a solution for repos to opt-in. Preferably repos that are libraries should do this.
