Forem Creators and Builders ๐ŸŒฑ

Cover image for Renaming things and broken links
Michael Tharrington
Michael Tharrington

Posted on

Renaming things and broken links

As we've renamed our repo and are also changing our /internal tooling to /admin + changing /admin to /resource_admin, I just want to highlight that these name changes may cause URLs to be broken, which is confusing for folks.

If possible, we should announce these name changes clearly or set up redirects.

For example, a few users have written in to ask about how to access our API documentation. They expect it to live here - https://docs.dev.to/api/ which redirects them to https://docs.forem.com/* (Page not found), when in fact the documentation lives here - https://docs.forem.com/api/.

Is there a set process for making these changes and testing them after the fact?

Top comments (4)

Collapse
 
rhymes profile image
rhymes

The PR for /internal to /admin is coming right up:

Redirect /internal to /admin #9716

What type of PR is this? (check all applicable)

  • [ ] Refactor
  • [ ] Feature
  • [x] Bug Fix
  • [ ] Optimization
  • [ ] Documentation Update

Description

I noticed how a bunch of my bookmarks to Blazer queries are broken because they point to /internal which is now called /admin. Prompted also by @michael-tharrington's post here on forem.dev I added redirections for the old /internal links.

QA Instructions, Screenshots, Recordings

Added tests?

  • [ ] yes
  • [x] no, because they aren't needed
  • [ ] no, because I need help
Collapse
 
andy profile image
Andy Zhao

thaaaanks :D

Collapse
 
andy profile image
Andy Zhao

Oh oops that redirect is a bug to be fixed. Thanks for raising that.

Collapse
 
ben profile image
Ben Halpern

Lol at https://docs.forem.com/*