From 9c5a8c9c31a4e0fb0fde5e20cc0b4f445a8a6d64 Mon Sep 17 00:00:00 2001 From: Audrow Nash Date: Fri, 24 Sep 2021 10:18:50 -0700 Subject: [PATCH] Change "Guides" to "How-to Guides" (#1972) * Change "Guides" to "How-to Guides" Signed-off-by: Audrow Nash * Add redirects Signed-off-by: Audrow Nash --- rosindex.yml | 2 +- source/Concepts/About-Build-System.rst | 2 +- source/Concepts/About-Cross-Compilation.rst | 2 +- .../About-Different-Middleware-Vendors.rst | 4 +- source/Concepts/About-RQt.rst | 2 +- source/Contributing/Developer-Guide.rst | 2 +- source/Contributing/Migration-Guide.rst | 2 +- source/Features.rst | 4 +- source/Guides.rst | 42 ----------------- source/How-To-Guides.rst | 46 +++++++++++++++++++ .../Ament-CMake-Documentation.rst | 1 + .../Ament-CMake-Python-Documentation.rst | 4 ++ .../Building-a-Custom-Debian-Package.rst | 4 ++ .../Cross-compilation.rst | 1 + .../{Guides => How-To-Guides}/DDS-tuning.rst | 1 + .../Developing-a-ROS-2-Package.rst | 1 + .../Installation-Troubleshooting.rst | 1 + .../Launch-file-different-formats.rst | 4 ++ .../Launch-files-migration-guide.rst | 1 + .../Node-arguments.rst | 1 + ...oS-Policies-For-Recording-And-Playback.rst | 1 + .../Package-maintainer-guide.rst | 4 ++ .../Parameters-YAML-files-migration-guide.rst | 1 + .../RQt-Port-Plugin-Windows.rst | 1 + .../RQt-Source-Install-MacOS.rst | 1 + .../RQt-Source-Install-Windows10.rst | 1 + .../RQt-Source-Install.rst | 1 + .../Releasing-a-ROS-2-package-with-bloom.rst | 1 + ...n-single-or-separate-docker-containers.rst | 1 + .../Sync-Vs-Async.rst | 1 + .../Using-Python-Packages.rst | 1 + ...king-with-multiple-RMW-implementations.rst | 1 + source/Installation/DDS-Implementations.rst | 2 +- .../Working-with-Eclipse-CycloneDDS.rst | 2 +- .../Working-with-eProsima-Fast-DDS.rst | 2 +- .../Installation/RHEL-Development-Setup.rst | 2 +- source/Installation/RHEL-Install-Binary.rst | 4 +- source/Installation/RHEL-Install-RPMs.rst | 4 +- .../Installation/Ubuntu-Development-Setup.rst | 2 +- source/Installation/Ubuntu-Install-Binary.rst | 4 +- .../Installation/Ubuntu-Install-Debians.rst | 4 +- .../Windows-Development-Setup.rst | 2 +- .../Installation/Windows-Install-Binary.rst | 2 +- .../Installation/macOS-Development-Setup.rst | 2 +- source/Releases.rst | 2 +- source/Releases/Beta2-Overview.rst | 2 +- source/Releases/Release-Bouncy-Bolson.rst | 4 +- .../Releases/Release-Galactic-Geochelone.rst | 2 +- source/Releases/Release-Humble-Hawksbill.rst | 2 +- source/Tutorials.rst | 2 +- .../Launch-Files/Creating-Launch-Files.rst | 2 +- .../Security/Introducing-ros2-security.rst | 2 +- source/index.rst | 4 +- 53 files changed, 117 insertions(+), 79 deletions(-) delete mode 100644 source/Guides.rst create mode 100644 source/How-To-Guides.rst rename source/{Guides => How-To-Guides}/Ament-CMake-Documentation.rst (99%) rename source/{Guides => How-To-Guides}/Ament-CMake-Python-Documentation.rst (97%) rename source/{Guides => How-To-Guides}/Building-a-Custom-Debian-Package.rst (95%) rename source/{Guides => How-To-Guides}/Cross-compilation.rst (99%) rename source/{Guides => How-To-Guides}/DDS-tuning.rst (99%) rename source/{Guides => How-To-Guides}/Developing-a-ROS-2-Package.rst (99%) rename source/{Guides => How-To-Guides}/Installation-Troubleshooting.rst (99%) rename source/{Guides => How-To-Guides}/Launch-file-different-formats.rst (99%) rename source/{Guides => How-To-Guides}/Launch-files-migration-guide.rst (99%) rename source/{Guides => How-To-Guides}/Node-arguments.rst (99%) rename source/{Guides => How-To-Guides}/Overriding-QoS-Policies-For-Recording-And-Playback.rst (98%) rename source/{Guides => How-To-Guides}/Package-maintainer-guide.rst (99%) rename source/{Guides => How-To-Guides}/Parameters-YAML-files-migration-guide.rst (97%) rename source/{Guides => How-To-Guides}/RQt-Port-Plugin-Windows.rst (98%) rename source/{Guides => How-To-Guides}/RQt-Source-Install-MacOS.rst (97%) rename source/{Guides => How-To-Guides}/RQt-Source-Install-Windows10.rst (98%) rename source/{Guides => How-To-Guides}/RQt-Source-Install.rst (98%) rename source/{Guides => How-To-Guides}/Releasing-a-ROS-2-package-with-bloom.rst (97%) rename source/{Guides => How-To-Guides}/Run-2-nodes-in-single-or-separate-docker-containers.rst (97%) rename source/{Guides => How-To-Guides}/Sync-Vs-Async.rst (99%) rename source/{Guides => How-To-Guides}/Using-Python-Packages.rst (99%) rename source/{Guides => How-To-Guides}/Working-with-multiple-RMW-implementations.rst (99%) diff --git a/rosindex.yml b/rosindex.yml index f4d4a9b182a..9927509a57f 100644 --- a/rosindex.yml +++ b/rosindex.yml @@ -9,7 +9,7 @@ index_pattern: - index.rst - Installation.rst - Tutorials.rst - - Guides.rst + - How-To-Guides.rst - Concepts.rst - Contributing.rst - Releases.rst diff --git a/source/Concepts/About-Build-System.rst b/source/Concepts/About-Build-System.rst index ad34b775fb2..5da7086d11b 100644 --- a/source/Concepts/About-Build-System.rst +++ b/source/Concepts/About-Build-System.rst @@ -98,7 +98,7 @@ Here a list of the |packages| in the repository along with a short description: - ``ament_cmake_python`` - provides CMake functions for |packages| that contain Python code - - see the `ament_cmake_python user documentation <../Guides/Ament-CMake-Python-Documentation>`__ + - see the `ament_cmake_python user documentation <../How-To-Guides/Ament-CMake-Python-Documentation>`__ - ``ament_cmake_test`` diff --git a/source/Concepts/About-Cross-Compilation.rst b/source/Concepts/About-Cross-Compilation.rst index 3682a1cdb23..4aebcdb906c 100644 --- a/source/Concepts/About-Cross-Compilation.rst +++ b/source/Concepts/About-Cross-Compilation.rst @@ -27,4 +27,4 @@ It is a Python script that compiles ROS 2 source files for supported target arch Detailed design of the tool can be found on `ROS 2 design `__. Instructions to use the tool are in the `cross_compile package `__. -If you are using an older version, please follow the `cross-compilation guide <../Guides/Cross-compilation>`. +If you are using an older version, please follow the `cross-compilation guide <../How-To-Guides/Cross-compilation>`. diff --git a/source/Concepts/About-Different-Middleware-Vendors.rst b/source/Concepts/About-Different-Middleware-Vendors.rst index 94bd976016f..ef6fd1895c1 100644 --- a/source/Concepts/About-Different-Middleware-Vendors.rst +++ b/source/Concepts/About-Different-Middleware-Vendors.rst @@ -43,7 +43,7 @@ Supported RMW implementations - ``rmw_connextdds`` - Full support. Support included in binaries, but Connext installed separately. -For practical information on working with multiple RMW implementations, see the `"Working with multiple RMW implementations" <../Guides/Working-with-multiple-RMW-implementations>` tutorial. +For practical information on working with multiple RMW implementations, see the `"Working with multiple RMW implementations" <../How-To-Guides/Working-with-multiple-RMW-implementations>` tutorial. Multiple RMW implementations ---------------------------- @@ -79,4 +79,4 @@ The implementation identifier is the name of the ROS package that provides the R For example, if both ``rmw_fastrtps_cpp`` and ``rmw_connextdds`` ROS packages are installed, ``rmw_connextdds`` would be the default. If ``rmw_cyclonedds_cpp`` is ever installed, it would be the default. -See the `guide <../Guides/Working-with-multiple-RMW-implementations>` for how to specify which RMW implementation is to be used when running the ROS 2 examples. +See the `guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` for how to specify which RMW implementation is to be used when running the ROS 2 examples. diff --git a/source/Concepts/About-RQt.rst b/source/Concepts/About-RQt.rst index 00d29104d02..b79ee2ec8e3 100644 --- a/source/Concepts/About-RQt.rst +++ b/source/Concepts/About-RQt.rst @@ -56,7 +56,7 @@ Installing From Debian Building From Source ^^^^^^^^^^^^^^^^^^^^ -See `Building RQt from Source <../Guides/RQt-Source-Install>`. +See `Building RQt from Source <../How-To-Guides/RQt-Source-Install>`. RQt Components Structure ------------------------ diff --git a/source/Contributing/Developer-Guide.rst b/source/Contributing/Developer-Guide.rst index aefec747c5c..a36fd26967c 100644 --- a/source/Contributing/Developer-Guide.rst +++ b/source/Contributing/Developer-Guide.rst @@ -285,7 +285,7 @@ When filing an issue please make sure to: - Upgrading to the latest version of the code, which may include bug fixes that have not been released yet. See `this section ` and follow the instructions to get the "master" branches. - Trying with a different RMW implementation. - See `this page <../Guides/Working-with-multiple-RMW-implementations>` for how to do that. + See `this page <../How-To-Guides/Working-with-multiple-RMW-implementations>` for how to do that. Pull requests ^^^^^^^^^^^^^ diff --git a/source/Contributing/Migration-Guide.rst b/source/Contributing/Migration-Guide.rst index 0b3a7961080..6ce378de003 100644 --- a/source/Contributing/Migration-Guide.rst +++ b/source/Contributing/Migration-Guide.rst @@ -415,7 +415,7 @@ Launch files ------------ While launch files in ROS 1 are always specified using `.xml `__ files, ROS 2 supports Python scripts to enable more flexibility (see `launch package `__) as well as XML and YAML files. -See `separate tutorial <../Guides/Launch-files-migration-guide>` on migrating launch files from ROS 1 to ROS 2. +See `separate tutorial <../How-To-Guides/Launch-files-migration-guide>` on migrating launch files from ROS 1 to ROS 2. Example: Converting an existing ROS 1 package to use ROS 2 ---------------------------------------------------------- diff --git a/source/Features.rst b/source/Features.rst index 489f239b640..0ed04c83a4a 100644 --- a/source/Features.rst +++ b/source/Features.rst @@ -17,7 +17,7 @@ For planned future development, see the :ref:`Roadmap `. - `Article `__ - * - Support for `multiple DDS implementations `, chosen at runtime - - `Concept `, `Guide ` + - `Concept `, `How-to Guide ` - Currently Eclipse Cyclone DDS, eProsima Fast DDS, and RTI Connext DDS are fully supported. * - Common core client library that is wrapped by language-specific libraries - `Details ` @@ -62,7 +62,7 @@ For planned future development, see the :ref:`Roadmap `. - `Article `__ - * - Static remapping of ROS names - - `Guide ` + - `How-to Guide ` - * - Demos of an all-ROS 2 mobile robot - `Demo `__ diff --git a/source/Guides.rst b/source/Guides.rst deleted file mode 100644 index 09f117cb543..00000000000 --- a/source/Guides.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. _Guides: - -Guides -====== - -Guides provide direct and modular answers to "How-to" questions regarding key aspects of ROS 2. -They contain succinct steps to help you accomplish important tasks quickly. - -Guides are meant for users who already have some knowledge of ROS 2 and just want to find out how to implement something specific. -They will not go in-depth by providing background information or teaching how a concept ties into the greater ROS 2 ecosystem. - -If you are new and looking to learn the ropes, start with the :ref:`Tutorials ` for a more well-rounded progression through ROS 2. - - - -.. toctree:: - :maxdepth: 1 - - Guides/Installation-Troubleshooting - Guides/Developing-a-ROS-2-Package - Guides/Ament-CMake-Documentation - Guides/Ament-CMake-Python-Documentation - Guides/Launch-files-migration-guide - Guides/Launch-file-different-formats - Guides/Parameters-YAML-files-migration-guide - Guides/Node-arguments - Guides/Sync-Vs-Async - Guides/DDS-tuning - Guides/Overriding-QoS-Policies-For-Recording-And-Playback - Guides/Working-with-multiple-RMW-implementations - Guides/Cross-compilation - Guides/Releasing-a-ROS-2-package-with-bloom - Guides/Using-Python-Packages - Guides/RQt-Port-Plugin-Windows - Guides/Run-2-nodes-in-single-or-separate-docker-containers - Guides/Package-maintainer-guide - Guides/Building-a-Custom-Debian-Package - -.. toctree:: - :hidden: - - Guides/RQt-Source-Install diff --git a/source/How-To-Guides.rst b/source/How-To-Guides.rst new file mode 100644 index 00000000000..0b491a6e7bf --- /dev/null +++ b/source/How-To-Guides.rst @@ -0,0 +1,46 @@ +.. redirect-from:: + + Guides + +.. _How-to Guides: + +How-to Guides +============= + +How-to Guides provide direct and modular answers to "How-to" questions regarding key aspects of ROS 2. +They contain succinct steps to help you accomplish important tasks quickly. + +How-to Guides are meant for users who already have some knowledge of ROS 2 and just want to find out how to implement something specific. +They will not go in-depth by providing background information or teaching how a concept ties into the greater ROS 2 ecosystem. + +If you are new and looking to learn the ropes, start with the :ref:`Tutorials ` for a more well-rounded progression through ROS 2. + + + +.. toctree:: + :maxdepth: 1 + + How-To-Guides/Installation-Troubleshooting + How-To-Guides/Developing-a-ROS-2-Package + How-To-Guides/Ament-CMake-Documentation + How-To-Guides/Ament-CMake-Python-Documentation + How-To-Guides/Launch-files-migration-guide + How-To-Guides/Launch-file-different-formats + How-To-Guides/Parameters-YAML-files-migration-guide + How-To-Guides/Node-arguments + How-To-Guides/Sync-Vs-Async + How-To-Guides/DDS-tuning + How-To-Guides/Overriding-QoS-Policies-For-Recording-And-Playback + How-To-Guides/Working-with-multiple-RMW-implementations + How-To-Guides/Cross-compilation + How-To-Guides/Releasing-a-ROS-2-package-with-bloom + How-To-Guides/Using-Python-Packages + How-To-Guides/RQt-Port-Plugin-Windows + How-To-Guides/Run-2-nodes-in-single-or-separate-docker-containers + How-To-Guides/Package-maintainer-guide + How-To-Guides/Building-a-Custom-Debian-Package + +.. toctree:: + :hidden: + + How-To-Guides/RQt-Source-Install diff --git a/source/Guides/Ament-CMake-Documentation.rst b/source/How-To-Guides/Ament-CMake-Documentation.rst similarity index 99% rename from source/Guides/Ament-CMake-Documentation.rst rename to source/How-To-Guides/Ament-CMake-Documentation.rst index a3c0d0f2f2b..910167d9758 100644 --- a/source/Guides/Ament-CMake-Documentation.rst +++ b/source/How-To-Guides/Ament-CMake-Documentation.rst @@ -1,5 +1,6 @@ .. redirect-from:: + Guides/Ament-CMake-Documentation Tutorials/Ament-CMake-Documentation ament_cmake user documentation diff --git a/source/Guides/Ament-CMake-Python-Documentation.rst b/source/How-To-Guides/Ament-CMake-Python-Documentation.rst similarity index 97% rename from source/Guides/Ament-CMake-Python-Documentation.rst rename to source/How-To-Guides/Ament-CMake-Python-Documentation.rst index cd8190432f4..44c55adb66c 100644 --- a/source/Guides/Ament-CMake-Python-Documentation.rst +++ b/source/How-To-Guides/Ament-CMake-Python-Documentation.rst @@ -1,3 +1,7 @@ +.. redirect-from:: + + Guides/Ament-CMake-Python-Documentation + ament_cmake_python user documentation ===================================== diff --git a/source/Guides/Building-a-Custom-Debian-Package.rst b/source/How-To-Guides/Building-a-Custom-Debian-Package.rst similarity index 95% rename from source/Guides/Building-a-Custom-Debian-Package.rst rename to source/How-To-Guides/Building-a-Custom-Debian-Package.rst index c532e48bf5e..71fc0c8c6a2 100644 --- a/source/Guides/Building-a-Custom-Debian-Package.rst +++ b/source/How-To-Guides/Building-a-Custom-Debian-Package.rst @@ -1,3 +1,7 @@ +.. redirect-from:: + + Guides/Building-a-Custom-Debian-Package + Building a custom Debian package ================================ diff --git a/source/Guides/Cross-compilation.rst b/source/How-To-Guides/Cross-compilation.rst similarity index 99% rename from source/Guides/Cross-compilation.rst rename to source/How-To-Guides/Cross-compilation.rst index b8400982674..bf4614a4abc 100644 --- a/source/Guides/Cross-compilation.rst +++ b/source/How-To-Guides/Cross-compilation.rst @@ -1,5 +1,6 @@ .. redirect-from:: + Guides/Cross-compilation Tutorials/Cross-compilation Cross-compilation diff --git a/source/Guides/DDS-tuning.rst b/source/How-To-Guides/DDS-tuning.rst similarity index 99% rename from source/Guides/DDS-tuning.rst rename to source/How-To-Guides/DDS-tuning.rst index 0a9161453a5..8efb738e61d 100644 --- a/source/Guides/DDS-tuning.rst +++ b/source/How-To-Guides/DDS-tuning.rst @@ -1,5 +1,6 @@ .. redirect-from:: + Guides/DDS-tuning Troubleshooting/DDS-tuning DDS tuning information diff --git a/source/Guides/Developing-a-ROS-2-Package.rst b/source/How-To-Guides/Developing-a-ROS-2-Package.rst similarity index 99% rename from source/Guides/Developing-a-ROS-2-Package.rst rename to source/How-To-Guides/Developing-a-ROS-2-Package.rst index 25f3a3310aa..dd13c6fb9a1 100644 --- a/source/Guides/Developing-a-ROS-2-Package.rst +++ b/source/How-To-Guides/Developing-a-ROS-2-Package.rst @@ -1,6 +1,7 @@ .. redirect-from:: Developing-a-ROS-2-Package + Guides/Developing-a-ROS-2-Package Tutorials/Developing-a-ROS-2-Package Developing a ROS 2 package diff --git a/source/Guides/Installation-Troubleshooting.rst b/source/How-To-Guides/Installation-Troubleshooting.rst similarity index 99% rename from source/Guides/Installation-Troubleshooting.rst rename to source/How-To-Guides/Installation-Troubleshooting.rst index 7cf23bf3a01..d238c37dc71 100644 --- a/source/Guides/Installation-Troubleshooting.rst +++ b/source/How-To-Guides/Installation-Troubleshooting.rst @@ -1,5 +1,6 @@ .. redirect-from:: + Guides/Installation-Troubleshooting Troubleshooting/Installation-Troubleshooting Installation troubleshooting diff --git a/source/Guides/Launch-file-different-formats.rst b/source/How-To-Guides/Launch-file-different-formats.rst similarity index 99% rename from source/Guides/Launch-file-different-formats.rst rename to source/How-To-Guides/Launch-file-different-formats.rst index 02c01a03073..85d2ad5c363 100644 --- a/source/Guides/Launch-file-different-formats.rst +++ b/source/How-To-Guides/Launch-file-different-formats.rst @@ -1,3 +1,7 @@ +.. redirect-from:: + + Guides/Launch-file-different-formats + Using Python, XML, and YAML for ROS 2 Launch Files ================================================== diff --git a/source/Guides/Launch-files-migration-guide.rst b/source/How-To-Guides/Launch-files-migration-guide.rst similarity index 99% rename from source/Guides/Launch-files-migration-guide.rst rename to source/How-To-Guides/Launch-files-migration-guide.rst index 8d5e2a7bfd0..55691519d12 100644 --- a/source/Guides/Launch-files-migration-guide.rst +++ b/source/How-To-Guides/Launch-files-migration-guide.rst @@ -1,5 +1,6 @@ .. redirect-from:: + Guides/Launch-files-migration-guide Tutorials/Launch-files-migration-guide .. _MigratingLaunch: diff --git a/source/Guides/Node-arguments.rst b/source/How-To-Guides/Node-arguments.rst similarity index 99% rename from source/Guides/Node-arguments.rst rename to source/How-To-Guides/Node-arguments.rst index d546faef81c..d15c623de6f 100644 --- a/source/Guides/Node-arguments.rst +++ b/source/How-To-Guides/Node-arguments.rst @@ -1,6 +1,7 @@ .. redirect-from:: Node-arguments + Guides/Node-arguments Tutorials/Node-arguments Passing ROS arguments to nodes via the command-line diff --git a/source/Guides/Overriding-QoS-Policies-For-Recording-And-Playback.rst b/source/How-To-Guides/Overriding-QoS-Policies-For-Recording-And-Playback.rst similarity index 98% rename from source/Guides/Overriding-QoS-Policies-For-Recording-And-Playback.rst rename to source/How-To-Guides/Overriding-QoS-Policies-For-Recording-And-Playback.rst index 69b188f40b6..8779016cba8 100644 --- a/source/Guides/Overriding-QoS-Policies-For-Recording-And-Playback.rst +++ b/source/How-To-Guides/Overriding-QoS-Policies-For-Recording-And-Playback.rst @@ -1,5 +1,6 @@ .. redirect-from:: + Guides/Overriding-QoS-Policies-For-Recording-And-Playback Tutorials/Ros2bag/Overriding-QoS-Policies-For-Recording-And-Playback .. _ROS2Bag-QoS-Override: diff --git a/source/Guides/Package-maintainer-guide.rst b/source/How-To-Guides/Package-maintainer-guide.rst similarity index 99% rename from source/Guides/Package-maintainer-guide.rst rename to source/How-To-Guides/Package-maintainer-guide.rst index 9c56c7f63ed..409d977400c 100644 --- a/source/Guides/Package-maintainer-guide.rst +++ b/source/How-To-Guides/Package-maintainer-guide.rst @@ -1,3 +1,7 @@ +.. redirect-from:: + + Guides/Package-maintainer-guide + ROS 2 Package Maintainer Guide ============================== diff --git a/source/Guides/Parameters-YAML-files-migration-guide.rst b/source/How-To-Guides/Parameters-YAML-files-migration-guide.rst similarity index 97% rename from source/Guides/Parameters-YAML-files-migration-guide.rst rename to source/How-To-Guides/Parameters-YAML-files-migration-guide.rst index afaf171b7b5..43659f6f048 100644 --- a/source/Guides/Parameters-YAML-files-migration-guide.rst +++ b/source/How-To-Guides/Parameters-YAML-files-migration-guide.rst @@ -1,5 +1,6 @@ .. redirect-from:: + Guides/Parameters-YAML-files-migration-guide Tutorials/Parameters-YAML-files-migration-guide .. _yaml-ros1-ros2: diff --git a/source/Guides/RQt-Port-Plugin-Windows.rst b/source/How-To-Guides/RQt-Port-Plugin-Windows.rst similarity index 98% rename from source/Guides/RQt-Port-Plugin-Windows.rst rename to source/How-To-Guides/RQt-Port-Plugin-Windows.rst index 753799a5afd..8f917bcae64 100644 --- a/source/Guides/RQt-Port-Plugin-Windows.rst +++ b/source/How-To-Guides/RQt-Port-Plugin-Windows.rst @@ -1,6 +1,7 @@ .. redirect-from:: RQt-Port-Plugin-Windows + Guides/RQt-Port-Plugin-Windows Tutorials/RQt-Port-Plugin-Windows Porting RQt plugins to Windows diff --git a/source/Guides/RQt-Source-Install-MacOS.rst b/source/How-To-Guides/RQt-Source-Install-MacOS.rst similarity index 97% rename from source/Guides/RQt-Source-Install-MacOS.rst rename to source/How-To-Guides/RQt-Source-Install-MacOS.rst index 45261716875..c94af6991bc 100644 --- a/source/Guides/RQt-Source-Install-MacOS.rst +++ b/source/How-To-Guides/RQt-Source-Install-MacOS.rst @@ -1,6 +1,7 @@ .. redirect-from:: RQt-Source-Install-MacOS + Guides/RQt-Source-Install-MacOS Building RQt from source on macOS ================================= diff --git a/source/Guides/RQt-Source-Install-Windows10.rst b/source/How-To-Guides/RQt-Source-Install-Windows10.rst similarity index 98% rename from source/Guides/RQt-Source-Install-Windows10.rst rename to source/How-To-Guides/RQt-Source-Install-Windows10.rst index 6984eae3dd0..bff6eb8ce79 100644 --- a/source/Guides/RQt-Source-Install-Windows10.rst +++ b/source/How-To-Guides/RQt-Source-Install-Windows10.rst @@ -1,6 +1,7 @@ .. redirect-from:: RQt-Source-Install-Windows10 + Guides/RQt-Source-Install-Windows10 Building RQt from source on Windows 10 ====================================== diff --git a/source/Guides/RQt-Source-Install.rst b/source/How-To-Guides/RQt-Source-Install.rst similarity index 98% rename from source/Guides/RQt-Source-Install.rst rename to source/How-To-Guides/RQt-Source-Install.rst index 249d088bc1d..d78a221f57f 100644 --- a/source/Guides/RQt-Source-Install.rst +++ b/source/How-To-Guides/RQt-Source-Install.rst @@ -1,6 +1,7 @@ .. redirect-from:: RQt-Source-Install + Guides/RQt-Source-Install Building RQt from source ======================== diff --git a/source/Guides/Releasing-a-ROS-2-package-with-bloom.rst b/source/How-To-Guides/Releasing-a-ROS-2-package-with-bloom.rst similarity index 97% rename from source/Guides/Releasing-a-ROS-2-package-with-bloom.rst rename to source/How-To-Guides/Releasing-a-ROS-2-package-with-bloom.rst index 24edb86b0e2..862ea705079 100644 --- a/source/Guides/Releasing-a-ROS-2-package-with-bloom.rst +++ b/source/How-To-Guides/Releasing-a-ROS-2-package-with-bloom.rst @@ -1,6 +1,7 @@ .. redirect-from:: Releasing-a-ROS-2-package-with-bloom + Guides/Releasing-a-ROS-2-package-with-bloom Tutorials/Releasing-a-ROS-2-package-with-bloom Releasing a ROS 2 package with bloom diff --git a/source/Guides/Run-2-nodes-in-single-or-separate-docker-containers.rst b/source/How-To-Guides/Run-2-nodes-in-single-or-separate-docker-containers.rst similarity index 97% rename from source/Guides/Run-2-nodes-in-single-or-separate-docker-containers.rst rename to source/How-To-Guides/Run-2-nodes-in-single-or-separate-docker-containers.rst index 0e7c4f8a99a..9dec19c9180 100644 --- a/source/Guides/Run-2-nodes-in-single-or-separate-docker-containers.rst +++ b/source/How-To-Guides/Run-2-nodes-in-single-or-separate-docker-containers.rst @@ -2,6 +2,7 @@ Tutorials/Run-2-nodes-in-a-single-docker-container Tutorials/Run-2-nodes-in-two-separate-docker-containers + Guides/Run-2-nodes-in-two-separate-docker-containers Running ROS 2 nodes in Docker [community-contributed] ===================================================== diff --git a/source/Guides/Sync-Vs-Async.rst b/source/How-To-Guides/Sync-Vs-Async.rst similarity index 99% rename from source/Guides/Sync-Vs-Async.rst rename to source/How-To-Guides/Sync-Vs-Async.rst index a0eeb886225..fa9664a86db 100644 --- a/source/Guides/Sync-Vs-Async.rst +++ b/source/How-To-Guides/Sync-Vs-Async.rst @@ -1,5 +1,6 @@ .. redirect-from:: + Guides/Sync-Vs-Async Tutorials/Sync-Vs-Async .. _SyncAsync: diff --git a/source/Guides/Using-Python-Packages.rst b/source/How-To-Guides/Using-Python-Packages.rst similarity index 99% rename from source/Guides/Using-Python-Packages.rst rename to source/How-To-Guides/Using-Python-Packages.rst index 949c0a36eb0..614c04e4b6d 100644 --- a/source/Guides/Using-Python-Packages.rst +++ b/source/How-To-Guides/Using-Python-Packages.rst @@ -1,5 +1,6 @@ .. redirect-from:: + Guides/Using-Python-Packages Tutorials/Using-Python-Packages .. _PythonPackages: diff --git a/source/Guides/Working-with-multiple-RMW-implementations.rst b/source/How-To-Guides/Working-with-multiple-RMW-implementations.rst similarity index 99% rename from source/Guides/Working-with-multiple-RMW-implementations.rst rename to source/How-To-Guides/Working-with-multiple-RMW-implementations.rst index 483e66e875f..1f88edb5d4a 100644 --- a/source/Guides/Working-with-multiple-RMW-implementations.rst +++ b/source/How-To-Guides/Working-with-multiple-RMW-implementations.rst @@ -1,6 +1,7 @@ .. redirect-from:: Working-with-multiple-RMW-implementations + Guides/Working-with-multiple-RMW-implementations Tutorials/Working-with-multiple-RMW-implementations Working with multiple ROS 2 middleware implementations diff --git a/source/Installation/DDS-Implementations.rst b/source/Installation/DDS-Implementations.rst index 225d1bfd972..337de691ec8 100644 --- a/source/Installation/DDS-Implementations.rst +++ b/source/Installation/DDS-Implementations.rst @@ -21,7 +21,7 @@ Since Eloquent, both Fast DDS and Cyclone DDS are bundled, but Fast DDS is still If you would like to use one of the other vendors you will need to install their software separately before building. The ROS 2 build will automatically build support for vendors that have been installed and sourced correctly. -Once you've installed a new DDS vendor, you can change the vendor used at runtime: `Working with Multiple RMW Implementations `. +Once you've installed a new DDS vendor, you can change the vendor used at runtime: `Working with Multiple RMW Implementations `. Detailed instructions for installing other DDS vendors are provided below. diff --git a/source/Installation/DDS-Implementations/Working-with-Eclipse-CycloneDDS.rst b/source/Installation/DDS-Implementations/Working-with-Eclipse-CycloneDDS.rst index 498c02d2de2..44469475b49 100644 --- a/source/Installation/DDS-Implementations/Working-with-Eclipse-CycloneDDS.rst +++ b/source/Installation/DDS-Implementations/Working-with-Eclipse-CycloneDDS.rst @@ -59,7 +59,7 @@ Switch from other rmw to rmw_cyclonedds by specifying the environment variable. export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp -See also: `Working with multiple RMW implementations <../../Guides/Working-with-multiple-RMW-implementations>` +See also: `Working with multiple RMW implementations <../../How-To-Guides/Working-with-multiple-RMW-implementations>` Run the talker and listener --------------------------- diff --git a/source/Installation/DDS-Implementations/Working-with-eProsima-Fast-DDS.rst b/source/Installation/DDS-Implementations/Working-with-eProsima-Fast-DDS.rst index d46d5d7d2f0..cffd2746bd8 100644 --- a/source/Installation/DDS-Implementations/Working-with-eProsima-Fast-DDS.rst +++ b/source/Installation/DDS-Implementations/Working-with-eProsima-Fast-DDS.rst @@ -54,7 +54,7 @@ The eProsima Fast DDS RMW can be selected by specifying the environment variable export RMW_IMPLEMENTATION=rmw_fastrtps_cpp -See also: `Working with multiple RMW implementations <../../Guides/Working-with-multiple-RMW-implementations>` +See also: `Working with multiple RMW implementations <../../How-To-Guides/Working-with-multiple-RMW-implementations>` Run the talker and listener --------------------------- diff --git a/source/Installation/RHEL-Development-Setup.rst b/source/Installation/RHEL-Development-Setup.rst index a4baae84bb6..450cc37553a 100644 --- a/source/Installation/RHEL-Development-Setup.rst +++ b/source/Installation/RHEL-Development-Setup.rst @@ -165,7 +165,7 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the Additional RMW implementations (optional) ----------------------------------------- The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime. -See the `guide <../Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. +See the `guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. Alternate compilers ------------------- diff --git a/source/Installation/RHEL-Install-Binary.rst b/source/Installation/RHEL-Install-Binary.rst index a2f406e65f0..af0fba391e8 100644 --- a/source/Installation/RHEL-Install-Binary.rst +++ b/source/Installation/RHEL-Install-Binary.rst @@ -125,12 +125,12 @@ Continue with the `tutorials and demos <../Tutorials>` to configure your environ Additional RMW implementations (optional) ----------------------------------------- The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime. -See the `guide <../Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. +See the `guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. Troubleshooting --------------- -Troubleshooting techniques can be found `here <../Guides/Installation-Troubleshooting>`. +Troubleshooting techniques can be found `here <../How-To-Guides/Installation-Troubleshooting>`. Uninstall --------- diff --git a/source/Installation/RHEL-Install-RPMs.rst b/source/Installation/RHEL-Install-RPMs.rst index ac28ee41ee3..7074a2e4112 100644 --- a/source/Installation/RHEL-Install-RPMs.rst +++ b/source/Installation/RHEL-Install-RPMs.rst @@ -111,12 +111,12 @@ Continue with the `tutorials and demos <../Tutorials>` to configure your environ Additional RMW implementations (optional) ----------------------------------------- The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime. -See the `guide <../Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. +See the `guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. Troubleshooting --------------- -Troubleshooting techniques can be found `here <../Guides/Installation-Troubleshooting>`. +Troubleshooting techniques can be found `here <../How-To-Guides/Installation-Troubleshooting>`. Uninstall --------- diff --git a/source/Installation/Ubuntu-Development-Setup.rst b/source/Installation/Ubuntu-Development-Setup.rst index 3b221fde260..b434c7712ad 100644 --- a/source/Installation/Ubuntu-Development-Setup.rst +++ b/source/Installation/Ubuntu-Development-Setup.rst @@ -174,7 +174,7 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the Additional RMW implementations (optional) ----------------------------------------- The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime. -See the `guide <../Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. +See the `guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. Alternate compilers ------------------- diff --git a/source/Installation/Ubuntu-Install-Binary.rst b/source/Installation/Ubuntu-Install-Binary.rst index 62941178491..6f31c9767ee 100644 --- a/source/Installation/Ubuntu-Install-Binary.rst +++ b/source/Installation/Ubuntu-Install-Binary.rst @@ -130,12 +130,12 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the Additional RMW implementations (optional) ----------------------------------------- The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime. -See the `guide <../Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. +See the `guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. Troubleshooting --------------- -Troubleshooting techniques can be found `here <../Guides/Installation-Troubleshooting>`. +Troubleshooting techniques can be found `here <../How-To-Guides/Installation-Troubleshooting>`. Uninstall --------- diff --git a/source/Installation/Ubuntu-Install-Debians.rst b/source/Installation/Ubuntu-Install-Debians.rst index cde69508179..7afeab2d184 100644 --- a/source/Installation/Ubuntu-Install-Debians.rst +++ b/source/Installation/Ubuntu-Install-Debians.rst @@ -106,12 +106,12 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the Additional RMW implementations (optional) ----------------------------------------- The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime. -See the `guide <../Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. +See the `guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. Troubleshooting --------------- -Troubleshooting techniques can be found `here <../Guides/Installation-Troubleshooting>`. +Troubleshooting techniques can be found `here <../How-To-Guides/Installation-Troubleshooting>`. Uninstall --------- diff --git a/source/Installation/Windows-Development-Setup.rst b/source/Installation/Windows-Development-Setup.rst index 4da68abd9c5..63de57e1480 100644 --- a/source/Installation/Windows-Development-Setup.rst +++ b/source/Installation/Windows-Development-Setup.rst @@ -187,7 +187,7 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the Additional RMW implementations (optional) ----------------------------------------- The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime. -See the `guide <../Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. +See the `guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. Extra stuff for Debug mode diff --git a/source/Installation/Windows-Install-Binary.rst b/source/Installation/Windows-Install-Binary.rst index 7004543a736..1a5fbcedb76 100644 --- a/source/Installation/Windows-Install-Binary.rst +++ b/source/Installation/Windows-Install-Binary.rst @@ -82,7 +82,7 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the Additional RMW implementations (optional) ----------------------------------------- The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime. -See the `guide <../Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. +See the `guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. Troubleshooting --------------- diff --git a/source/Installation/macOS-Development-Setup.rst b/source/Installation/macOS-Development-Setup.rst index a5226b48dba..c91de800740 100644 --- a/source/Installation/macOS-Development-Setup.rst +++ b/source/Installation/macOS-Development-Setup.rst @@ -208,7 +208,7 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the Additional RMW implementations (optional) ----------------------------------------- The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime. -See the `guide <../Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. +See the `guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs. Stay up to date --------------- diff --git a/source/Releases.rst b/source/Releases.rst index 64ec13fd0c9..55115492935 100644 --- a/source/Releases.rst +++ b/source/Releases.rst @@ -169,7 +169,7 @@ The Rolling distribution of ROS 2 serves as a staging area for future stable dis Unlike most stable ROS 2 distributions which have an initial release, a support window during which they are updated, and a definite end of support (see :ref:`list_of_distributions` above) the Rolling distribution is continuously updated and is subject to in-place updates which will at times include breaking changes. Packages released into the Rolling distribution will be automatically released into future stable distributions of ROS 2. -`Releasing a ROS 2 package ` into the Rolling distribution follows the same procedures as all other ROS 2 distributions. +`Releasing a ROS 2 package ` into the Rolling distribution follows the same procedures as all other ROS 2 distributions. `ROS 2 Rolling Ridley ` is the rolling development distribution of ROS 2 as proposed in `REP 2002 `_. It was first introduced in June 2020. diff --git a/source/Releases/Beta2-Overview.rst b/source/Releases/Beta2-Overview.rst index 2af5d677c1d..6e4ab357bbc 100644 --- a/source/Releases/Beta2-Overview.rst +++ b/source/Releases/Beta2-Overview.rst @@ -23,7 +23,7 @@ Improvements since Beta 1 release * DDS_Security support (aka SROS2, see `sros2 `__) * Debian packages for Ubuntu Xenial -* Typesupport has been redesigned so that you only build a single executable and can choose one of the available RMW implementations by setting an environment variable (see `documentation <../Guides/Working-with-multiple-RMW-implementations>`). +* Typesupport has been redesigned so that you only build a single executable and can choose one of the available RMW implementations by setting an environment variable (see `documentation <../How-To-Guides/Working-with-multiple-RMW-implementations>`). * Namespace support for nodes and topics (see `design article `__, see known issues below). * A set of command-line tools using the extensible ``ros2`` command (see `conceptual article <../Concepts/About-Command-Line-Tools>`). * A set of macros for logging messages in C / C++ (see API docs of `rcutils `__). diff --git a/source/Releases/Release-Bouncy-Bolson.rst b/source/Releases/Release-Bouncy-Bolson.rst index 5852c1024a5..f318aa16c4e 100644 --- a/source/Releases/Release-Bouncy-Bolson.rst +++ b/source/Releases/Release-Bouncy-Bolson.rst @@ -38,8 +38,8 @@ New features in this ROS 2 release * `New launch system <../Tutorials/Launch-system>` featuring a much more capable and flexible Python API. -* Parameters can be passed as `command line arguments <../Guides/Node-arguments>` to C++ executables. -* Static remapping via `command line arguments <../Guides/Node-arguments>`. +* Parameters can be passed as `command line arguments <../How-To-Guides/Node-arguments>` to C++ executables. +* Static remapping via `command line arguments <../How-To-Guides/Node-arguments>`. * Various improvements to the Python client library. * Support for publishing and subscribing to serialized data. This is the foundation for the upcoming work towards a native rosbag implementation. diff --git a/source/Releases/Release-Galactic-Geochelone.rst b/source/Releases/Release-Galactic-Geochelone.rst index d92110d8aaa..8acd9590cda 100644 --- a/source/Releases/Release-Galactic-Geochelone.rst +++ b/source/Releases/Release-Galactic-Geochelone.rst @@ -497,7 +497,7 @@ Default RMW changed to Eclipse Cyclone DDS During the Galactic development process, the ROS 2 Technical Steering Committee `voted `__ to change the default ROS middleware (RMW) to `Eclipse Cyclone DDS `__ project of `Eclipse Foundation `__. Without any configuration changes, users will get Eclipse Cyclone DDS by default. Fast DDS and Connext are still Tier-1 supported RMW vendors, and users can opt-in to use one of these RMWs at their discretion by using the ``RMW_IMPLEMENTATION`` environment variable. -See the `Working with multiple RMW implementations guide <../Guides/Working-with-multiple-RMW-implementations>` for more information. +See the `Working with multiple RMW implementations guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` for more information. Connext RMW changed to rmw_connextdds ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/source/Releases/Release-Humble-Hawksbill.rst b/source/Releases/Release-Humble-Hawksbill.rst index 0e7fcaa6784..22238341f7c 100644 --- a/source/Releases/Release-Humble-Hawksbill.rst +++ b/source/Releases/Release-Humble-Hawksbill.rst @@ -44,7 +44,7 @@ New features in this ROS 2 release ``ros_args`` attribute & ``ros_arguments`` parameter for nodes in launch files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -It is now possible to provide `ROS-specific node arguments <../Guides/Node-arguments>` directly, without needing to use ``args`` with a leading ``--ros-args`` flag: +It is now possible to provide `ROS-specific node arguments <../How-To-Guides/Node-arguments>` directly, without needing to use ``args`` with a leading ``--ros-args`` flag: .. tabs:: diff --git a/source/Tutorials.rst b/source/Tutorials.rst index 4abb4d23a60..26a0718ee22 100644 --- a/source/Tutorials.rst +++ b/source/Tutorials.rst @@ -7,7 +7,7 @@ The tutorials are a collection of step-by-step instructions meant to steadily bu The best way to approach the tutorials is to walk through them for the first time in order, as they build off of each other and are not meant to be comprehensive documentation. -For quick solutions to more specific questions, see the :ref:`Guides`. +For quick solutions to more specific questions, see the :ref:`How-To Guides`. Beginner -------- diff --git a/source/Tutorials/Launch-Files/Creating-Launch-Files.rst b/source/Tutorials/Launch-Files/Creating-Launch-Files.rst index 9f4af1473ef..4568d47549e 100644 --- a/source/Tutorials/Launch-Files/Creating-Launch-Files.rst +++ b/source/Tutorials/Launch-Files/Creating-Launch-Files.rst @@ -248,6 +248,6 @@ Next steps .. note:: You can also use XML and YAML to create launch files. - You can see a comparison of these different ROS 2 launch formats in :doc:`../../Guides/Launch-file-different-formats`. + You can see a comparison of these different ROS 2 launch formats in :doc:`../../How-To-Guides/Launch-file-different-formats`. In the next tutorial, :ref:`ROS2Bag`, you'll learn about another helpful tool, ``ros2bag``. diff --git a/source/Tutorials/Security/Introducing-ros2-security.rst b/source/Tutorials/Security/Introducing-ros2-security.rst index d26a628b635..84f815104fb 100644 --- a/source/Tutorials/Security/Introducing-ros2-security.rst +++ b/source/Tutorials/Security/Introducing-ros2-security.rst @@ -77,7 +77,7 @@ Selecting an alternate middleware If you choose not to use the default middleware implementation, be sure to `change your DDS implementation <../../Installation/DDS-Implementations>` before proceeding. ROS2 allows you to change the DDS implementation at runtime. -See `how to work with mulitple RMW implementations <../../Guides/Working-with-multiple-RMW-implementations>` to explore different middleware implementations. +See `how to work with mulitple RMW implementations <../../How-To-Guides/Working-with-multiple-RMW-implementations>` to explore different middleware implementations. Note that secure communication between vendors is not supported. diff --git a/source/index.rst b/source/index.rst index 427e66d984d..a8af7161ec5 100644 --- a/source/index.rst +++ b/source/index.rst @@ -9,7 +9,7 @@ ROS 2 Documentation Installation Tutorials - Guides + How-To-Guides Concepts Contributing Contact @@ -46,7 +46,7 @@ Newcomers and experienced ROS users should consult this overview of our user-cen * :ref:`Tutorials ` walk you through small projects and sample usage of ROS 2, so you can learn the ropes by actually using the tools. They are organized by progression of necessary skills, making it the best place to start for new users. -* :ref:`Guides ` answer all your "How do I...?" questions as short and to-the-point as possible, so you can find the information you need without needing to work through the narrative nature of the tutorials for context. +* :ref:`How-to Guides` answer all your "How do I...?" questions as short and to-the-point as possible, so you can find the information you need without needing to work through the narrative nature of the tutorials for context. * :ref:`Concepts ` are high-level explanations and background information on core ROS 2 concepts, which should provide some context for topics covered in the tutorials.