Skip to content
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

Support redirect alias for renamed repos, so we can change the repo name without breaking old links and always show the new repo name #90

Open
prasek opened this issue Nov 12, 2020 · 0 comments

Comments

@prasek
Copy link
Contributor

prasek commented Nov 12, 2020

Problem

When a repo is renamed in GitHub doc.crds.dev will redirect to the correct repo, as it just uses the one provided to point to, that is then being redirected when we clone and parse.

However the repo name will not automatically update, so you see the old repo name in doc.crds.dev and still have to use the old url when linking to the docs from other sites.

If we change the repo being indexed in config.yaml think old link will be broken, so it's unclear how to get doc.crds.dev to show the new repo name, with a new link, without breaking the old links or having duplicate entries in config.yaml.

image

The new repo name for ☝️ is https://github.com/packethost/crossplane-provider-equinix-metal/.

What can we do to help?

Would be nice to have a redirect alias for the old repo name to point at the new repo name.

Maybe something like this for config.yaml:

apiVersion: v1
kind: Namespace
metadata:
  name: crdsdev
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: doc-repos
  namespace: crdsdev
data:
  repos: "crossplane/crossplane,crossplane/provider-gcp,crossplane/provider-aws,crossplane/provider-azure,crossplane/provider-alibaba,crossplane/provider-rook,crossplane-contrib/provider-helm,kubernetes-sigs/cluster-api,jetstack/cert-manager,schemahero/schemahero,projectcontour/contour,packethost/crossplane-provider-packet,kubernetes-sigs/cluster-api-provider-packet,crossplane/oam-kubernetes-runtime"
  aliases:
    - alias: old
      target: new
    - alias: packethost/crossplane-provider-packet
      target: packethost/crossplane-provider-equinix-metal
@prasek prasek changed the title Support redirect alias for renamed repos, so we can change the repo name without breaking old links Support redirect alias for renamed repos, so we can change the repo name without breaking old links and always show the new repo name Nov 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant