ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange
Ask Your Question
1

Adding Tutorial link automatically to a wiki page

asked 2022-01-28 05:42:34 -0600

Hi,

I've created a tutorial for the ros_canopen package : http://wiki.ros.org/ros_canopen.

I made the tutorial according to this guideline : http://wiki.ros.org/WritingTutorials. The tutorial page is located here: http://wiki.ros.org/ros_canopen/tutor...

I would like the ros_canopen page to display the Tutorial links automatically in the gray square entitled "Package Links" on the upper right, but at the moment it doesn't. I read on ROS Answers that it can take up to 3 days, but I can't find any official information regarding that, and it has been a week since I published it.

Am I missing something to get that link displayed or should I just wait longer or refresh something by myself ?

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted
1

answered 2022-01-28 11:08:50 -0600

gvdhoorn gravatar image

updated 2022-01-28 11:12:22 -0600

I've "fixed" it for you.

In order for the Package Link box to show the Tutorials link, a sub page called Tutorials must exist below ros_canopen.

It must have the correct case (ie: PascalCase), must be called Tutorials (not tutorial) and it must actually exist. Simply having "Tutorials" in the path/URL is not sufficient.

Now that it exists and is correctly named, wiki/ros_canopen shows the link to its Tutorials sub page. It's empty though, so no one can find the tutorial. I've left that for you to fix.

I read on ROS Answers that it can take up to 3 days, but I can't find any official information regarding that, and it has been a week since I published it.

that "three day waiting period" is for a different documentation system. The wiki does not use that.


With that out of the way:

First: +100 for making tutorials. Especially for ros_canopen, as it's largely undocumented.

Having written that: I would recommend you reconsider "abusing" the wiki tutorial system to only link to off-site content. The main idea behind the ROS wiki is for anyone with an account to be able to edit and update it. That's how we keep things going in this community (and many other communities).

Off-site content does not typically allow that. If you stop updating that PDF, it will go stale pretty quickly, and it'll be rather difficult to update by anyone else, as they don't have access to the source.

edit flag offensive delete link more

Comments

Hi @gvdhoorn, thank you for fixing the Tutorials page, I used the lower case "tutorials" indeed. So I also deleted my wrong "tutorials" page as it can't be reach from the wiki.

Thank you for your suggestion about rethinking the tutorials presentation, and agree that it would fit better to the ROS philosophy. I am planning to make a few self-contained tutorials and to add them on the new Tutorials page.

Cyril Jourdan gravatar image Cyril Jourdan  ( 2022-02-04 11:17:55 -0600 )edit

Hi @gvdhoorn, I think I saw the information to create a /tutorials page as opposed to a /Tutorials on the following page, which needs to be fixed: http://wiki.ros.org/ROS/Tutorials/Nav... Do you recommend reporting that typo to the maintainer of that page or can I just fix it myself ?

Cyril Jourdan gravatar image Cyril Jourdan  ( 2022-02-18 05:34:55 -0600 )edit

You can probably just change that yourself.

gvdhoorn gravatar image gvdhoorn  ( 2022-02-19 09:28:20 -0600 )edit

Question Tools

2 followers

Stats

Asked: 2022-01-28 05:42:34 -0600

Seen: 114 times

Last updated: Jan 28 '22