Clarify "Getting Started" launch file change

The added note should help new users or ROS 2 Dashing users avoid issues with the "Getting Started" launch file, and also explain preference for Eloquent and later. ros-navigation/navigation2#1607 ros-navigation/navigation2#1663 ros-navigation#9 ros-navigation#36
GuanyangLuo · Jul 4, 2020 · c386d68 · c386d68
1 parent 43758c3
commit c386d68
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/getting_started/index.rst b/getting_started/index.rst
@@ -51,6 +51,14 @@ Running the Example
    .. code-block:: bash
 
       ros2 launch nav2_bringup tb3_simulation_launch.py
+   
+   .. note::
+
+      For ``ROS 2 Dashing Diademata`` or earlier, use
+      ``nav2_simulation_launch.py``.
+      However, it is highly recommended to use Navigation 2 with ``ROS 2
+      Eloquent Elusor`` or later for **massively** improved stablity and
+      feature completeness.
 
    This launch file will launch Navigation2 with the AMCL localizer in the
    ``turtlebot3_world`` world.