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

Fix wiki button directing to ros1 wiki #471

Open
wants to merge 1 commit into
base: ros2
Choose a base branch
from

Conversation

EmmanuelMess
Copy link

@EmmanuelMess EmmanuelMess commented Feb 5, 2025

Fixes #92

@EmmanuelMess EmmanuelMess force-pushed the emmanuelmess/fix/wiki_button branch from c221d3e to 8837026 Compare February 5, 2025 16:43
@EmmanuelMess EmmanuelMess marked this pull request as ready for review February 5, 2025 16:43
@EmmanuelMess
Copy link
Author

@sloretz please review

@rkent
Copy link

rkent commented Feb 5, 2025

I have tested this, and it works. The code also seems fine.

My hesitation is that there are many packages that have been adapted from ROS1 and have their primary documentation still on the wiki. An example is https://index.ros.org/p/ackermann_msgs/ Now that package actually points to the wiki in its README, but others do not. Without this PR, the user sees a working link to the old wiki page since this is also a ROS1 package. With the PR, that link is gone. You could always find it by selecting an older distro though I suppose.

I'm not sure which is preferable. Any thoughts?

@EmmanuelMess
Copy link
Author

My hesitation is that there are many packages that have been adapted from ROS1 and have their primary documentation still on the wiki. An example is index.ros.org/p/ackermann_msgs Now that package actually points to the wiki in its README, but others do not. Without this PR, the user sees a working link to the old wiki page since this is also a ROS1 package. With the PR, that link is gone. You could always find it by selecting an older distro though I suppose.

I'm not sure which is preferable. Any thoughts?

(Oh no. And the API link is broken for ROS2.)

In my opinion the bigger issue here is that we can't have the documentation and API spread across multiple pages (http://wiki.ros.org, ros.org, ros2.org) because this inconsistency is not conducive to good developer experience. This is part of the work to consolidate links and improve UX.
Can't work be done to move the docs to the new breathe/inhale system?

@clalancette
Copy link

In my opinion the bigger issue here is that we can't have the documentation and API spread across multiple pages (http://wiki.ros.org, ros.org, ros2.org) because this inconsistency is not conducive to good developer experience. This is part of the work to consolidate links and improve UX.
Can't work be done to move the docs to the new breathe/inhale system?

This is actively being done. Both https://wiki.ros.org and https://docs.ros2.org are currently deprecated. The only canonical place to get ROS 2 documentation is on https://docs.ros.org, and https://index.ros.org should point to that.

However, in the particular case of https://wiki.ros.org, we can't take that offline for the rest of the life of ROS 1, and probably for some time after that. And it is not worth the effort to convert ROS 1 to the breathe/exhale system, as it is going EOL in a few months. So I don't know that there is much more we can do here.

@rkent
Copy link

rkent commented Feb 5, 2025

The only canonical place to get ROS 2 documentation is on https://docs.ros.org, and https://index.ros.org should point to that.

I take it then @clalancette that you are in favor of NOT showing a link to the wiki page for ros2 packages, which means you are in favor of accepting the current PR?

@clalancette
Copy link

I take it then @clalancette that you are in favor of NOT showing a link to the wiki page for ros2 packages, which means you are in favor of accepting the current PR?

Yes, I agree with that.

Copy link

@rkent rkent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't normally do reviews except for people who have commit access, as I cannot commit myself. But I have tested this, it works, and is good. So here's a so-called "gray checkmark" review.

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

Successfully merging this pull request may close these issues.

Disable wiki button for ROS 2 versions
3 participants