doc(controller-server): publish_zero_velocity parameter (ros-navigati…

…on#593)

Signed-off-by: Rob Fisher <[email protected]>

configuration/packages/configuring-controller-server.rst

@@ -36,6 +36,17 @@ Parameters
   Description
     Adds soft real-time prioritization to the controller server to better ensure resources to time sensitive portions of the codebase. This will set the controller's execution thread to a higher priority than the rest of the system (``90``) to meet scheduling deadlines to have less missed loop rates. To use this feature, you use set the following inside of ``/etc/security/limits.conf`` to give userspace access to elevated prioritization permissions: ``<username> soft rtprio 99 <username> hard rtprio 99``
 
+:publish_zero_velocity:
+
+  ============== =======
+  Type           Default
+  -------------- -------
+  bool           true
+  ============== =======
+
+  Description
+    Whether to publish a zero velocity command on goal exit. This is useful for stopping the robot when a goal terminates.
+
 :action_server_result_timeout:
 
   ====== ======= ======= 

migration/Jazzy.rst

@@ -91,3 +91,11 @@ Default value:
 
 - false
 
+Option to disable zero velocity publishing on goal exit
+*******************************************************
+
+In `PR #4675 <https://github.com/ros-navigation/navigation2/pull/4675>`_ a ``publish_zero_velocity`` parameter was introduced for the `Controller server </configuration/packages/configuring-controller-server.html#controller-server>`_ in order to disable zero velocity publishing on goal exit.
+
+Default value:
+
+- true