Prefered place to contribute new example code

[BryceStevenWilley]

In my opinion, it would be nice to have a single goto place to see working examples of ROS2 code, similar to ros_tutorials, and I want to try to help with that. Given that there are 3 different places for ROS2 example code (demos, examples, and this repo):

• which repo is the best target for new tutorial writing/addition of example code?
• is there any interest in accepting PRs that port code from the examples or demo repo to this repo, with additional comments to make them tutorial like?
• this comment states that this repo won't be released/worked on until a documentation platform was up and running. Is https://index.ros.org/doc/ros2/Tutorials/ that documentation platform? And should some of these examples be better integrated there?

Possibly related to #7.

[dirk-thomas]

it would be nice to have a single goto place to see working examples of ROS2 code, similar to ros_tutorials

There are multiple repositories in ROS 1 containing different tutorials: ros_tutorials, common_tutorials, visualization_tutorials. That allows independent people to maintain them and release them on their own schedule.

which repo is the best target for new tutorial writing/addition of example code?

• demos contains for each feature the recommended way how it can be used and is covered by unit tests.
• examples contains for each feature multiple ways it can be used to show the variety (e.g. callback via instance method, global function or lambda, or e.g. using a timer vs. using a while loop in the main).

So depending on what kind you are interested to write one location will be more appropriate than the other.

is there any interest in accepting PRs that port code from the examples or demo repo to this repo, with additional comments to make them tutorial like?

Instead of duplicating the code from demos here I would rather suggest contributing additional comments there.

this comment states that this repo won't be released/worked on until a documentation platform was up and running. Is https://index.ros.org/doc/ros2/Tutorials/ that documentation platform?

While index.ros.org provides one platforms for some documentatio it is not the needed platform for that context. In ROS 1 there are repository / package specific doc jobs on Jenkins which generate e.g. API docs or any other kind of documentation from the sources of a repository containing ROS packages. These kind of jobs do not exist for ROS 2 yet. The idea is that once those become available that this repository contains the code used in the tutorials as well as the tutorial text itself which then references the code lines. Without this you need to duplicate the code snippets in the text-only tutorial written somewhere else (like index.ros.org) which is likely diverting quickly.

I want to try to help with that

Any help - especially for writing documentation and tutorials - is greatly appreciated. Please consider to contribute to either of the currently used locations (index.ros.org and demos / example). If you have larger additions in mind also consider to create a ticket about it first to allow early feedback and avoid that others are working on something similar.

[BryceStevenWilley]

Thanks for the clarifications.

There are multiple repositories in ROS 1 containing different tutorials

I think I misstated my desire; essentially I think the index.ros.org tutorials should be more similar to the ros_tutorials wiki, in that you can follow each tutorial sequentially and have each part of the ROS ecosystem introduced to you as you need it, as opposed to have a separate page for building with colcon, one for rosidl, etc. However, I think this vision requires the doc jobs, since, as you mentioned, any tutorial written without it will quickly be out of date with how fast ROS 2 is changing.

These kind of jobs do not exist for ROS 2 yet.

Is there anywhere I can follow updates for doc jobs for ROS 2?

[dirk-thomas]

Is there anywhere I can follow updates for doc jobs for ROS 2?

This work has not been scheduled yet, so there is neither a meta ticket nor a timeline for it atm.