Skip to content

3di | Create "About nodes" article - #7164

Open
dmarshant wants to merge 24 commits into
ros2:rollingfrom
3di-for-openrobotics:about-nodes
Open

dmarshant wants to merge 24 commits into
ros2:rollingfrom
3di-for-openrobotics:about-nodes

Conversation

@dmarshant

Copy link
Copy Markdown
Contributor

This update is part of #6826

Description

Created an About Nodes article based on information across multiple other articles.

Fixes #6826

Did you use Generative AI?

No

Additional Information

Documentation updates from 3di Information Solutions, agreed with Geoff and Tully.

Should be backported to Lyrical

@dmarshant dmarshant changed the title About nodes 3di | Create "About nodes" article Sep 8, 2026

@vmbrasseur vmbrasseur left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@kscottz kscottz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few comments. This is acceptable as is but I do feel like it could use more concrete descriptions. I added more context in a few spots.

One thing we should probably discuss is the "managed nodes" moniker. I get that the docs used "managed node" and "lifecycle node" interchangeably but I think we should shorten just pick one and stick with it.

@fujitatomoya @christophebedard thoughts?

Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
#. Nodes periodically advertise their presence so that connections can be made with new-found entities, even after the initial discovery period.
#. Nodes advertise to other nodes when they go offline.

Nodes only establish connections with other nodes if they have compatible *quality of service* settings.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit of an advanced topic and mostly applies to topic subscriptions. We may want an info box around this.

Comment thread source/ROS-Framework/About-Nodes.rst Outdated
* Composable nodes
A composable node contains separate components with shared memory.
Learn more about how to write a composable node: :doc:`nodes/Working-with-nodes/Writing-a-Composable-Node`
* Managed nodes, also known as lifecycle nodes

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be the other way around. I don't think "managed node" is used outside of the documentation.

Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Connections between nodes are established through a distributed :doc:`discovery <nodes/About-Discovery>` process.
What is the difference between composable nodes and managed nodes?
Composable nodes are components that can share a process and memory.
Managed nodes, also called lifecycle nodes, move through defined states so resources are started and shut down in a controlled order.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, I think we should just use "lifecycle node" here for consistency.

Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst Outdated
Comment thread source/ROS-Framework/About-Nodes.rst
@kscottz kscottz self-assigned this Sep 10, 2026
3di-for-openrobotics and others added 19 commits September 14, 2026 10:13
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: 3di Information Solutions <openrobotics@3di-info.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3di | Create "About" articles for the main functionality areas

6 participants