Ask Your Question
0

How to update ROS Wiki Documentation?

asked 2021-05-20 11:37:37 -0600

csg gravatar image

updated 2021-05-20 14:34:25 -0600

I found an error in a ROS Wiki I was reading, can I change the source code and submit a PR? Where can I find the source code? The wiki page is related to ros_comm, I checked the source code but couldn't find the documentation in there. https://github.com/ros/ros_comm/

On the bottom of the page I see (last edited 2019-06-26 19:17:45 by DavidLu)

Do I need to contact DavidLu?

edit retag flag offensive close merge delete

Comments

1

@csg: could you please update your post with a link to the page you are referring to?

Most wiki pages which refer to source code use embedding through a macro, which would mean the code in the ros_comm repository would need fixing.

It could well be that there is something incorrect, but the packages in ros_comm are pretty old and well used, so perhaps something else is going on.

gvdhoorn gravatar image gvdhoorn  ( 2021-05-21 01:56:34 -0600 )edit

1 Answer

Sort by ยป oldest newest most voted
0

answered 2021-05-20 14:23:56 -0600

updated 2021-05-20 14:27:31 -0600

See this page, under "How to Edit a ROS Wiki Page" http://wiki.ros.org/EditingTheWiki#Ho...

In short, you have to create an account on wiki.ros.org, then request to be added to the ROS wiki whitelist by commenting on a specific issue (mention your username and why you want to edit the wiki/what page you want to edit). Once this is done, go back to the wiki page you want to modify, and click "Edit" on the right.

edit flag offensive delete link more

Comments

Adding to this: if the source code @csg mentions is embedded on the page (using the macro which takes source from a Git repository and displays it inline, with line nrs), instead of copy-pasted into the page, you cannot change it by editing the wiki page itself.

You'd have to submit a PR to fix the code in the Git repository.

gvdhoorn gravatar image gvdhoorn  ( 2021-05-21 01:54:42 -0600 )edit

you're right, that might be it. The question was a bit ambiguous!

christophebedard gravatar image christophebedard  ( 2021-05-21 08:26:47 -0600 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

1 follower

Stats

Asked: 2021-05-20 11:37:37 -0600

Seen: 44 times

Last updated: May 20