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

redirect documentation dbrgn -> tealdeer-rs #392

Open
CouldBeThis opened this issue Nov 24, 2024 · 2 comments
Open

redirect documentation dbrgn -> tealdeer-rs #392

CouldBeThis opened this issue Nov 24, 2024 · 2 comments

Comments

@CouldBeThis
Copy link

The output of --help in v1.5.0 (which is up to date as far as my debian machine is concerned) provides the wrong link to docs: https://dbrgn.github.io:

tldr --help
tealdeer 1.5.0
Danilo Bargen <mail@dbrgn.ch>, Niklas Mohrin <dev@niklasmohrin.de>
A fast TLDR client

...

To view the user documentation, please visit https://dbrgn.github.io/tealdeer/.

On a different device I have v1.7.1 and it's been updated to reflect github org tealdeer-rs. But given old versions hang around for a long time might make sense to workaround. And there will be links to the old site etc.

From searching the repo (didn't find a previous mention of this issue) looks like ownership was modified in #376. Assuming @dbrgn is still on good terms with the project I wonder if they would be willing to set up a redirect to current repo/docs?

Of course a person can websearch to find the correct repo (like I did). But as this is a popular beginner-level tool, hand-holding is not unreasonable.

@dbrgn
Copy link
Collaborator

dbrgn commented Nov 24, 2024

Hm, any idea how such a redirect would be set up?

On the GitHub level, the redirect actually works: https://github.com/dbrgn/tealdeer/ redirects to https://github.com/tealdeer-rs/tealdeer/. The same thing counts for issue URLs.

If I were to set up a new repository under my namespace, I'm fairly sure that it would break all those redirects 😕

@CouldBeThis
Copy link
Author

(Someone with more experience in this area could probably answer your question in 1 sentence rather than going on this long journey but I should give an effort.)

Well originally I was thinking it would be pretty simple. Now that I have thought about it more carefully I find maybe a bit more complicated. Here is the original idea with caveats:

  • create a github pages repo for your user
    • Caveat: Now I have websearched site:dbrgn.github.io and I see you are running other project sites under that domain. I can't get a clear answer about what happens if you run both repo/project sites and a user site. I am guessing if it was prohibited that would be clearly documented.
  • That will serve a site at dbrgn.github.io
  • Create a subdirectory of the site for /tealdeer-rs
  • use a 404 to serve an error to anyone who goes into the directory alerting them to the change
    • Caveat: I am getting the impression you can't specify a 404 per-directory. So if this worked I guess it would be an error page for the whole domain? Which wouldn't be worse than the current situation but would probably need to anticipate 404s in your personal projects as well.

It's been a while since I used github pages and I never got too much into jekyll so I don't know the ins n outs of it. The above might work without issue. I tried to verify/contradict that hypothesis and was unable to. But if there is a problem I think the solution would be found in one of these:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants