.. redirect-from::

  Docs-Guide

ROS 2 Documentation
===================

.. toctree::
   :titlesonly:
   :maxdepth: 1
   :hidden:

   Installation
   Releases
   Tutorials
   How-To-Guides
   Concepts
   Contact
   The-ROS2-Project
   Package-Docs
   Related-Projects
   Glossary
   Citations


**The Robot Operating System (ROS) is a set of software libraries and tools for building robot applications.**
From drivers and state-of-the-art algorithms to powerful developer tools, ROS has the open source tools you need for your next robotics project.

Since ROS was started in 2007, a lot has changed in the robotics and ROS community.
The goal of the ROS 2 project is to adapt to these changes, leveraging what is great about ROS 1 and improving what isn’t.

**Are you looking for documentation for a particular ROS package like MoveIt,  image_proc, or octomap?** Please see `ROS Index <https://index.ros.org/packages/#{DISTRO}>`__  or check out `this index of per-package documentation <https://docs.ros.org/en/{DISTRO}/p/>`__.

This site contains the documentation for ROS 2.
If you are looking for ROS 1 documentation, check out the `ROS wiki <https://wiki.ros.org>`__.

If you use ROS 2 in your work, please see :doc:`Citations <Citations>` to cite ROS 2.

Getting started
---------------

* :doc:`Installation <Installation>`

  - Instructions to set up ROS 2 for the first time

* :doc:`Tutorials <Tutorials>`

  - The best place to start for new users!
  - Hands-on sample projects that help you build a progression of necessary skills

* :doc:`How-To-Guides`

  - Quick answers to your "How do I...?" questions without working through the :doc:`Tutorials <Tutorials>`

* :doc:`Concepts <Concepts>`

  - High-level explanations of core ROS 2 concepts covered in the :doc:`Tutorials <Tutorials>`

* :doc:`Contact <Contact>`

  - Answers to your questions or a forum to start a discussion


The ROS 2 project
-----------------

If you're interested in the advancement of the ROS 2 project:

* :doc:`Contributing <The-ROS2-Project/Contributing>`

  - Best practices and methodology for contributing to ROS 2, as well as instructions for migrating existing ROS 1 content to ROS 2

* :doc:`Distributions <Releases>`

  - Past, present and future ROS 2 distributions

* :doc:`Features Status <The-ROS2-Project/Features>`

  - Features in the current release

* :doc:`Feature Ideas <The-ROS2-Project/Feature-Ideas>`

  - Ideas for nice-to-have features that are not under active development

* :doc:`Roadmap <The-ROS2-Project/Roadmap>`

  - Planned work for ROS 2 development

* :doc:`ROSCon Talks <The-ROS2-Project/ROSCon-Content>`

  - Presentations by the community on ROS 2

* :doc:`Project Governance <The-ROS2-Project/Governance>`

  - Information about the ROS Technical Steering Committee, Working Groups, and upcoming events

* :doc:`Marketing <The-ROS2-Project/Marketing>`

  - Downloadable marketing materials
  - `Information about the ROS trademark <https://www.ros.org/blog/media/>`__

ROS community resources
-----------------------

If you need help, have an idea, or would like to contribute to the project, please visit our ROS community resources.

* `Official ROS Discord Channel for discussion and support <https://discord.com/servers/open-robotics-1077825543698927656>`__ (ROS 1, ROS 2)

* `Robotics Stack Exchange - community Q&A website <https://robotics.stackexchange.com/>`__ (ROS 1, ROS 2)

  - See :ref:`Contact Page <Using Robotics Stack Exchange>` for more information

* `ROS Discourse <https://discourse.ros.org/>`__ (ROS 1, ROS 2)

  - Forum for general discussions and announcements for the ROS community
  - See the :ref:`Contact Page <Using ROS Discourse>` for more information

* `ROS Index <https://index.ros.org/>`__ (ROS 1, ROS 2)

  - Indexed list of all packages (i.e. `Python Package Index (PyPI) <https://pypi.org/>`_ for ROS packages)
  - See which ROS distributions a package supports
  - Link to a package's repository, API documentation, or website
  - Inspect a package's license, build type, maintainers, status, and dependencies
  - Get more info for a package on `Robotics Stack Exchange <https://robotics.stackexchange.com/>`__

* `ROS resource status page <https://status.openrobotics.org/>`__ (ROS 1, ROS 2)

  - Check the current status of ROS resources like Discourse or the ROS build farm.

General ROS project resources
-----------------------------

* `ROS Enhancement Proposals (REPs) <https://ros.org/reps/rep-0000.html>`__ (ROS 1, ROS 2)

  - Proposals for new designs and conventions

* `ROS Robots <https://robots.ros.org/>`__ (ROS 1, ROS 2)

  - Showcases robots projects from the community
  - Instructions on how to contribute a robot

* `ROS Wiki <http://wiki.ros.org/>`__ (ROS 1)

  - ROS 1 documentation and user modifiable content
  - Active until at least the last ROS 1 distribution is EOL

* `ROS.org <https://www.ros.org/>`__ (ROS 1, ROS 2)

  - ROS 1 and ROS 2 product landing page, with high-level description of ROS and links to other ROS sites

Events
------

* `Official ROS Vimeo Channel <https://vimeo.com/osrfoundation>`__ (ROS 1, ROS 2)

  - Videos of ROSCon Talks, community and working group meetings, and project demos.

* `ROSCon website <https://roscon.ros.org/>`__ (ROS 1, ROS 2)

  - ROSCon is our annual ROS developer conference.
  - This page also lists regional ROS events like ROSConJP and ROSConFr.

* `Open Source Robotics Foundation official events calendar <https://calendar.google.com/calendar/u/0/embed?src=agf3kajirket8khktupm9go748@group.calendar.google.com&ctz=America/Los_Angeles>`__

  - This calendar is for official OSRF Events and working group meetings.
  - `Submit your events here <https://bit.ly/OSRFCalendarForm>`__.

* `Open Source Robotics Foundation community calendar <https://calendar.google.com/calendar/embed?src=c_3fc5c4d6ece9d80d49f136c1dcd54d7f44e1acefdbe87228c92ff268e85e2ea0%40group.calendar.google.com&ctz=America%2FLos_Angeles>`__

  - This calendar is for unofficial ROS community events.
  - `Submit your events here <https://bit.ly/OSRFCommunityCalendar>`__ .

Miscellaneous
-------------
* `Purchase official ROS swag <https://spring.ros.org/>`__

* ROS on social media

  - `@OpenRoboticsOrg <https://twitter.com/OpenRoboticsOrg>`__ and `@ROSOrg <https://twitter.com/ROSOrg>`__ on Twitter
  - `Open Robotics on LinkedIn <https://www.linkedin.com/company/open-source-robotics-foundation>`__

* Visit the `Open Source Robotics Foundation website <https://www.openrobotics.org/>`__

  - Tax deductible charitable donations to the Open Source Robotics Foundation can be sent via `DonorBox. <https://donorbox.org/support-open-robotics?utm_medium=qrcode&utm_source=qrcode>`__

Deprecated
----------
* `ROS 2 Design <http://design.ros2.org/>`__

  - Early design decisions behind ROS 2 development
  - New design proposals should be submitted via `ROS Enhancement Proposals (REPs) <https://ros.org/reps/rep-0000.html>`__