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

How do I submit a ROS 2 tutorial?

asked 2020-09-21 02:53:25 -0500

BenBongalon gravatar image

I've been working on porting some ROS 1 tutorials to ROS 2 (example). It's not clear to me how to submit them because:

  1. wiki.ros seems to be only for ROS 1
  2. ROS Index is way different in organizational structure from the original Wiki

How do I proceed?

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted
1

answered 2020-09-21 12:54:45 -0500

tfoote gravatar image

You're correct that we're restructuring the tutorials layout for ROS 2.

If the tutorial that you're working on is a generic/core ROS 2 concept please contribute to https://github.com/ros2/ros2_document...

However if it's a package specific tutorial we are planning to keep those closer to the specific projects using sphinx and recommend contributing the tutorials to the packages themselves in a folder doc/tutorials using RST markdown. These will then be rendered next to the API documentation for each packages in a process we're working on setting up.

edit flag offensive delete link more

Comments

These will then be rendered next to the API documentation for each packages in a process we're working on setting up.

Is there already something you could tell us about this?

gvdhoorn gravatar image gvdhoorn  ( 2020-09-21 14:51:00 -0500 )edit

We're still experimenting and will circulate more for review when we get a working prototype.

tfoote gravatar image tfoote  ( 2020-09-21 17:21:30 -0500 )edit

@tfoote, thanks I will do that.

BenBongalon gravatar image BenBongalon  ( 2020-09-21 20:46:10 -0500 )edit

Question Tools

1 follower

Stats

Asked: 2020-09-21 02:53:25 -0500

Seen: 122 times

Last updated: Sep 21 '20