camunda-docs icon indicating copy to clipboard operation
camunda-docs copied to clipboard

What should we do with old redirect rules?

Open pepopowitz opened this issue 2 years ago • 4 comments

We should develop an official strategy for old redirect rules in the .htaccess file.

Conversationally @akeller and I have talked about how we don't care too much about redirecting for pages in old versions of the docs, as we want to nudge people to update to the latest version. We've also talked about how we don't care much about redirecting pages in the next version, because those docs are to be considered under construction.

Formalizing a strategy would:

  • Give us something to point at when people ask what our strategy is
  • Give us guidance on when to skip or delete rules from the .htaccess

pepopowitz avatar Oct 17 '22 19:10 pepopowitz

Similar to #1040.

akeller avatar Oct 18 '22 01:10 akeller

#1946 reminded me we should reduce the number of hops on our older redirects.

akeller avatar Apr 11 '23 15:04 akeller

I was revisiting this briefly and think we can tackle something small here to define what we do in this post-archival era.

  • Commit to the "strategy" below:
    • Anything with /next/ or a version number not supported/maintained can be deleted.
      • Exception - ongoing restructure work where a page is moving or being renamed and will be backported
      • Exception - restructure work as part of a minor release
    • Only maintain redirects for supported/maintained versions
    • Redirects do not need to be maintained beyond a simple whole redirect from docs.camunda.io to the archival/unsupported site
  • Execute the work
    • Delete redirects with version number not supported/maintained
    • Delete redirects with /next/ (unless part of restructure work)
    • Document the above "strategy" in the repo

This would be sufficient to close this issue out.

akeller avatar Aug 14 '23 15:08 akeller

I will move this into Ready and get a draft brewing for the strategy piece.

akeller avatar Aug 21 '23 19:08 akeller