ros-realtime / rtwg_documentation

Deprecated RTWG docs repository
https://real-time-working-group.readthedocs.io/en/latest/
Creative Commons Attribution 4.0 International
9 stars 4 forks source link

Deprecate repo #45

Closed carlossvg closed 2 years ago

carlossvg commented 2 years ago
christophebedard commented 2 years ago

Will we get 404 errors for existing links? Seems like only the root page (i.e., https://real-time-working-group.readthedocs.io/en/latest/) will show the "This website has been deprecated" message. It would be better to have all non-root pages link to the root page to avoid 404 errors (and let people know about the switch), or have each page redirect to the corresponding page on the new website.

carlossvg commented 2 years ago

Will we get 404 errors for existing links? Seems like only the root page (i.e., https://real-time-working-group.readthedocs.io/en/latest/) will show the "This website has been deprecated" message. It would be better to have all non-root pages link to the root page to avoid 404 errors (and let people know about the switch), or have each page redirect to the corresponding page on the new website.

Good point. I will do that.

carlossvg commented 2 years ago

@christophebedard I will try to do the trick by adding a custom 404.html redirecting to the new documentation. Like we do here but with a proper message https://github.com/ros-realtime/ros2_realtime_benchmarks/blob/main/docs/404.html.

LanderU commented 2 years ago

We should add the custom 404.html yes.

carlossvg commented 2 years ago

@christophebedard @LanderU I used sphinx-reredirects to redirect all the pages. This will automatically redirect all the old URLs to the new root URL. I think this is a cleaner solution.

Edit: it is possible to redirect a specific html to the corresponding html in the new UR. I think this is a bad idea because if the structure changes, users will get a 404 error in the new URL.