From fe36fe8f6a7b95bdf5f93449303c96a1906118dc Mon Sep 17 00:00:00 2001 From: Keith Kirkwood Date: Thu, 26 Mar 2026 14:38:24 +0000 Subject: [PATCH 1/3] OPENR-65: Create learning path for First steps and add to TOC --- source/First-Steps.rst | 102 +++++++++++++++++++++++++++++++++++++++++ source/index.rst | 1 + 2 files changed, 103 insertions(+) create mode 100644 source/First-Steps.rst diff --git a/source/First-Steps.rst b/source/First-Steps.rst new file mode 100644 index 00000000000..277720121ef --- /dev/null +++ b/source/First-Steps.rst @@ -0,0 +1,102 @@ +.. _First-steps-with-ROS-learning-path: + +First steps with ROS - learning path +==================================== + +.. centered:: ROS (Robot Operating System) is an open-source ecosystem that provides framework, tools, and libraries for building, deploying, running, and maintaining robotic applications. + This page presents a set of articles and hands-on activities to introduce the main concepts behind the ROS framework. + Working through these will give you the essential knowledge needed to start developing applications with ROS. + +.. parsed-literal:: + + Area: ROS-framework | Content-type: learning-path | Experience: beginner + +.. contents:: Contents + :depth: 2 + :local: + +Summary +------- + +The ROS framework is the “plumbing” which makes communication between different parts of a robot possible. +It includes messaging, standard interfaces, and support for multiple programming languages and platforms. + +You need to understand the fundamental concepts of the framework before you can work with ROS to develop or maintain applications. +The turtlesim tool and the tutorials in this site will help you get up to speed. + + +Prerequisites +------------- + +None. +The steps outlined in this article will guide you through downloading and installing everything you need to learn the basics of ROS. + +Steps +----- + +1 Learn about fundamental concepts behind ROS +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +* About ROS +* :doc:`/Concepts/Basic/About-Nodes` +* Interfaces (topics, services, actions) +* :doc:`/Concepts/Basic/About-Parameters` + +2 Install ROS and turtlesim +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +ROS installation includes the essential packages for working with ROS. +If you're familiar with Linux, our recommended platform is Ubuntu (deb packages). +Otherwise, a good alternative installation platform is Windows (binaries). + +:doc:`Installation options ` + +With turtlesim, a lightweight 2D simulation tool designed for beginners, you can learn core ROS concepts in a simple visual environment. + +:doc:`Install and set up turtlesim ` + +3 Try out working with the main communication components of the ROS framework +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Use turtlesim to familiarise yourself with the main communication components and try out messaging in the ROS framework. + +#. Complete the nodes tutorial: :doc:`/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Nodes/Understanding-ROS2-Nodes` +#. Complete the topics tutorial: :doc:`/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Topics/Understanding-ROS2-Topics` +#. Complete the services tutorial: :doc:`/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Services/Understanding-ROS2-Services` +#. Complete the parameters tutorial: :doc:`/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Parameters/Understanding-ROS2-Parameters` +#. Complete the actions tutorial: :doc:`/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Actions/Understanding-ROS2-Actions` + +4 Learn about introspection with logs +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Introspection enables you to see information about how a system is operating. +Nodes use logs to output messages concerning events and status in a variety of ways. + +To see introspection through logs in action, complete the rqt_console tutorial: + +:doc:`/Tutorials/Beginner-CLI-Tools/Using-Rqt-Console/Using-Rqt-Console` + +5 Learn about using launch files +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Launch files allow you to start and configure a number of processes containing ROS nodes simultaneously, instead of opening multiple terminals and reentering configuration details for each node. + +Complete the launch files tutorial: + +:doc:`/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes` + +6 Learn about data recording and playback +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sometimes it's useful to replay data to reproduce the results of your tests and experiments, to debug your robot's behaviour, or to share your work with others. + +Complete the recording and playback tutorial: + +:doc:`/Tutorials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data` + +Next steps +---------- + +To complete your knowledge of the ROS framework, we recommend familiarising yourself with ROS client libraries: + +:doc:`/Tutorials/Beginner-Client-Libraries` diff --git a/source/index.rst b/source/index.rst index 8305a172d96..10df4373e4a 100644 --- a/source/index.rst +++ b/source/index.rst @@ -10,6 +10,7 @@ ROS 2 Documentation :maxdepth: 1 :hidden: + First-Steps Installation Releases Tutorials From b7a2c804915531ba642aca4a014ced96f8b0f896 Mon Sep 17 00:00:00 2001 From: keithkirkwood-3di Date: Mon, 30 Mar 2026 15:41:28 +0000 Subject: [PATCH 2/3] OPENR-65: Update cross-references and fix typos --- source/First-Steps.rst | 28 ++++++++-------------------- source/Tutorials.rst | 1 + source/index.rst | 1 - 3 files changed, 9 insertions(+), 21 deletions(-) diff --git a/source/First-Steps.rst b/source/First-Steps.rst index 277720121ef..b7729a10592 100644 --- a/source/First-Steps.rst +++ b/source/First-Steps.rst @@ -47,18 +47,14 @@ Steps ROS installation includes the essential packages for working with ROS. If you're familiar with Linux, our recommended platform is Ubuntu (deb packages). -Otherwise, a good alternative installation platform is Windows (binaries). +Otherwise, a good alternative installation platform is Windows (binaries): :doc:`Installation options ` -:doc:`Installation options ` - -With turtlesim, a lightweight 2D simulation tool designed for beginners, you can learn core ROS concepts in a simple visual environment. - -:doc:`Install and set up turtlesim ` +With turtlesim, a lightweight 2D simulation tool designed for beginners, you can learn core ROS concepts in a simple visual environment: :doc:`Install and set up turtlesim ` 3 Try out working with the main communication components of the ROS framework ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Use turtlesim to familiarise yourself with the main communication components and try out messaging in the ROS framework. +Use turtlesim to familiarize yourself with the main communication components and try out messaging in the ROS framework. #. Complete the nodes tutorial: :doc:`/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Nodes/Understanding-ROS2-Nodes` #. Complete the topics tutorial: :doc:`/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Topics/Understanding-ROS2-Topics` @@ -72,31 +68,23 @@ Use turtlesim to familiarise yourself with the main communication components and Introspection enables you to see information about how a system is operating. Nodes use logs to output messages concerning events and status in a variety of ways. -To see introspection through logs in action, complete the rqt_console tutorial: - -:doc:`/Tutorials/Beginner-CLI-Tools/Using-Rqt-Console/Using-Rqt-Console` +To see introspection through logs in action, complete the rqt_console tutorial: :doc:`/Tutorials/Beginner-CLI-Tools/Using-Rqt-Console/Using-Rqt-Console` 5 Learn about using launch files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Launch files allow you to start and configure a number of processes containing ROS nodes simultaneously, instead of opening multiple terminals and reentering configuration details for each node. +Launch files allow you to start and configure a number of processes containing ROS nodes simultaneously, instead of opening multiple terminals and re-entering configuration details for each node. -Complete the launch files tutorial: - -:doc:`/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes` +Complete the launch files tutorial: :doc:`/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes` 6 Learn about data recording and playback ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Sometimes it's useful to replay data to reproduce the results of your tests and experiments, to debug your robot's behaviour, or to share your work with others. -Complete the recording and playback tutorial: - -:doc:`/Tutorials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data` +Complete the recording and playback tutorial: :doc:`/Tutorials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data` Next steps ---------- -To complete your knowledge of the ROS framework, we recommend familiarising yourself with ROS client libraries: - -:doc:`/Tutorials/Beginner-Client-Libraries` +To complete your knowledge of the ROS framework, we recommend familiarizing yourself with ROS client libraries: :doc:`/Tutorials/Beginner-Client-Libraries` diff --git a/source/Tutorials.rst b/source/Tutorials.rst index db3482adacb..e9516a52be6 100644 --- a/source/Tutorials.rst +++ b/source/Tutorials.rst @@ -12,6 +12,7 @@ For quick solutions to more specific questions, see the :doc:`How-To-Guides`. .. toctree:: :maxdepth: 2 + First-Steps Tutorials/Beginner-CLI-Tools Tutorials/Beginner-Client-Libraries Tutorials/Intermediate diff --git a/source/index.rst b/source/index.rst index 10df4373e4a..8305a172d96 100644 --- a/source/index.rst +++ b/source/index.rst @@ -10,7 +10,6 @@ ROS 2 Documentation :maxdepth: 1 :hidden: - First-Steps Installation Releases Tutorials From ab9a7d6cd1bffd1415c25cbfbeaaf6cb6dac1a94 Mon Sep 17 00:00:00 2001 From: keithkirkwood-3di Date: Thu, 16 Apr 2026 16:59:35 +0100 Subject: [PATCH 3/3] OPENR-65: Update formatting of initial content --- source/First-Steps.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/source/First-Steps.rst b/source/First-Steps.rst index b7729a10592..9f9783c3f7e 100644 --- a/source/First-Steps.rst +++ b/source/First-Steps.rst @@ -3,13 +3,11 @@ First steps with ROS - learning path ==================================== -.. centered:: ROS (Robot Operating System) is an open-source ecosystem that provides framework, tools, and libraries for building, deploying, running, and maintaining robotic applications. - This page presents a set of articles and hands-on activities to introduce the main concepts behind the ROS framework. - Working through these will give you the essential knowledge needed to start developing applications with ROS. +ROS (Robot Operating System) is an open-source ecosystem that provides framework, tools, and libraries for building, deploying, running, and maintaining robotic applications. +This page presents a set of articles and hands-on activities to introduce the main concepts behind the ROS framework. +Working through these will give you the essential knowledge needed to start developing applications with ROS. -.. parsed-literal:: - - Area: ROS-framework | Content-type: learning-path | Experience: beginner +**Area: ROS-framework | Content-type: learning-path | Experience: beginner** .. contents:: Contents :depth: 2