diff --git a/.github/workflows/rebase-ros2_documentation.yaml b/.github/workflows/rebase-ros2_documentation.yaml new file mode 100644 index 00000000000..0077a76268a --- /dev/null +++ b/.github/workflows/rebase-ros2_documentation.yaml @@ -0,0 +1,50 @@ +name: rebase-ros2_documentation + +on: + schedule: + - cron: '0 0 * * *' + #scheduled every midnight + workflow_dispatch: + # manual run of the workflow job + +jobs: + rebase-branches: + name: Rebase HEAD with upstream current branch + runs-on: ubuntu-latest + strategy: + matrix: + dest_branch: ['rolling', 'humble'] + + steps: + # Step 1: run a standard checkout action, provided by github (REQUIRED) + - name: Checkout target repo + uses: actions/checkout@v2 + with: + ref: ${{ matrix.dest_branch }} + fetch-depth: 0 + + # Step 2: Set git config and add remote (REQUIRED) + - name: Set git config and add remote + id: config + run: | + git config --local user.email "ricardogonzalez@eprosima.com" + git config --local user.name "richiprosima" + git remote add ros https://github.com/ros2/ros2_documentation.git + shell: bash + + # Step 3: Rebase + - name: Rebase current branch to upstream changes + id: rebase + run: | + git fetch ros ${{ matrix.dest_branch }} + git rebase ros/${{ matrix.dest_branch }} + shell: bash + + # Step 4: Push + - name: Force push if required + id: push + run: | + if [ "$(git status | grep 'diverged\|ahead')" ]; then + git push -f + fi; + shell: bash diff --git a/source/Concepts.rst b/source/Concepts.rst index 147ddea7b6b..98fc786d725 100644 --- a/source/Concepts.rst +++ b/source/Concepts.rst @@ -34,7 +34,6 @@ The Core Stack Developer Concepts are much more detailed conceptual articles int Concepts/About-Build-System Concepts/About-Internal-Interfaces Concepts/About-Middleware-Implementations - Concepts/About-ROS-2-Client-Libraries Quick overview of ROS 2 Concepts -------------------------------- @@ -95,7 +94,7 @@ It can be summarized as follows: #. 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 will only establish connections with other nodes if they have compatible :doc:`Quality of Service <../Tutorials/Demos/Quality-of-Service>` settings. +Nodes will only establish connections with other nodes if they have compatible :doc:`Quality of Service <./Tutorials>` settings. Take the :ref:`talker-listener demo ` for example. Running the C++ talker node in one terminal will publish messages on a topic, diff --git a/source/Concepts/About-Different-Middleware-Vendors.rst b/source/Concepts/About-Different-Middleware-Vendors.rst index 4ada90c11ab..f844b9e2d88 100644 --- a/source/Concepts/About-Different-Middleware-Vendors.rst +++ b/source/Concepts/About-Different-Middleware-Vendors.rst @@ -2,6 +2,8 @@ DDS-and-ROS-middleware-implementations +.. _concepts_ros2_vendors: + About different ROS 2 DDS/RTPS vendors ====================================== diff --git a/source/How-To-Guides/Developing-a-ROS-2-Package.rst b/source/How-To-Guides/Developing-a-ROS-2-Package.rst index cad1aa33bdf..bac91f95b75 100644 --- a/source/How-To-Guides/Developing-a-ROS-2-Package.rst +++ b/source/How-To-Guides/Developing-a-ROS-2-Package.rst @@ -17,7 +17,7 @@ It is intended for developers who want to learn how to create custom packages in Prerequisites ------------- -- :doc:`Install ROS <../../Installation>` +- :doc:`Install ROS <../Installation>` - `Install colcon `__ diff --git a/source/How-To-Guides/Releasing/_Next-Steps.rst b/source/How-To-Guides/Releasing/_Next-Steps.rst index 54b818751f3..3b5196d8bf5 100644 --- a/source/How-To-Guides/Releasing/_Next-Steps.rst +++ b/source/How-To-Guides/Releasing/_Next-Steps.rst @@ -1,5 +1,5 @@ Once your pull request has been submitted, usually within one or two days, one of the maintainers of rosdistro will review and merge your Pull Request. -If your package build is successful, in 24-48 hours your packages will become available in the **ros-testing** repository, where you can :doc:`test your pre-release binaries <../../../Installation/Testing>`. +If your package build is successful, in 24-48 hours your packages will become available in the **ros-testing** repository, where you can :doc:`test your pre-release binaries <../../Installation/Testing>`. Approximately every two to four weeks, the distribution's release manager manually synchronizes the contents of ros-testing into the main ROS repository. This is when your packages actually become available to the rest of the ROS community. diff --git a/source/Installation/Alternatives/images/windows-vs-studio-install.png b/source/Installation/Alternatives/images/windows-vs-studio-install.png new file mode 100644 index 00000000000..0084a177626 Binary files /dev/null and b/source/Installation/Alternatives/images/windows-vs-studio-install.png differ diff --git a/source/Installation/Maintaining-a-Source-Checkout.rst b/source/Installation/Maintaining-a-Source-Checkout.rst index 35dc899b064..489092c6a80 100644 --- a/source/Installation/Maintaining-a-Source-Checkout.rst +++ b/source/Installation/Maintaining-a-Source-Checkout.rst @@ -3,13 +3,6 @@ Maintain source checkout ======================== -.. ifconfig:: smv_current_version != '' and smv_current_version != 'rolling' - - .. note:: - - For instructions on maintaining a source checkout of the **latest development version** of ROS 2, refer to - `Maintaining a source checkout of ROS 2 Rolling <../../rolling/Installation/Maintaining-a-Source-Checkout.html>`__ - .. contents:: :depth: 2 :local: diff --git a/source/Installation/RHEL-Install-RPMs.rst b/source/Installation/RHEL-Install-RPMs.rst index 5a98ccfe05e..e41dbb36c4f 100644 --- a/source/Installation/RHEL-Install-RPMs.rst +++ b/source/Installation/RHEL-Install-RPMs.rst @@ -110,7 +110,7 @@ Hooray! Next steps after installing --------------------------- -Continue with the :doc:`tutorials and demos <../../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts. +Continue with the :doc:`tutorials and demos <../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts. Additional RMW implementations (optional) ----------------------------------------- diff --git a/source/Installation/Ubuntu-Install-Debians.rst b/source/Installation/Ubuntu-Install-Debians.rst index 2dd0f562484..2c5dc7b7881 100644 --- a/source/Installation/Ubuntu-Install-Debians.rst +++ b/source/Installation/Ubuntu-Install-Debians.rst @@ -111,7 +111,7 @@ Hooray! Next steps after installing --------------------------- -Continue with the :doc:`tutorials and demos <../../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts. +Continue with the :doc:`tutorials and demos <../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts. Using the ROS 1 bridge ---------------------- diff --git a/source/Installation/Windows-Install-Binary.rst b/source/Installation/Windows-Install-Binary.rst index 7b7799587d2..e30f8139f21 100644 --- a/source/Installation/Windows-Install-Binary.rst +++ b/source/Installation/Windows-Install-Binary.rst @@ -74,7 +74,7 @@ Hooray! Next steps after installing --------------------------- -Continue with the :doc:`tutorials and demos <../../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts. +Continue with the :doc:`tutorials and demos <../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts. Additional RMW implementations (optional) ----------------------------------------- diff --git a/source/Installation/_Windows-Install-Prerequisites.rst b/source/Installation/_Windows-Install-Prerequisites.rst index 545af51b72f..c228a572cd7 100644 --- a/source/Installation/_Windows-Install-Prerequisites.rst +++ b/source/Installation/_Windows-Install-Prerequisites.rst @@ -63,7 +63,7 @@ Make sure that the Visual C++ features are installed. An easy way to make sure they're installed is to select the ``Desktop development with C++`` workflow during the install. - .. image:: /Installation/images/windows-vs-studio-install.png + .. image:: ./images/windows-vs-studio-install.png Make sure that no C++ CMake tools are installed by unselecting them in the list of components to be installed. diff --git a/source/Releases.rst b/source/Releases.rst index 8b8d3a35695..c91f8098ab7 100644 --- a/source/Releases.rst +++ b/source/Releases.rst @@ -176,4 +176,4 @@ As the name implies, Rolling is continuously updated and **can have in-place upd We recommend that most people use the most recent stable distribution instead (see :ref:`list_of_distributions`). Packages released into the Rolling distribution will be automatically released into future stable distributions of ROS 2. -:doc:`Releasing a ROS 2 package <../How-To-Guides/Releasing/Releasing-a-Package>` into the Rolling distribution follows the same procedures as all other ROS 2 distributions. +:doc:`Releasing a ROS 2 package <./How-To-Guides/Releasing/Releasing-a-Package>` into the Rolling distribution follows the same procedures as all other ROS 2 distributions. diff --git a/source/The-ROS2-Project/Contributing.rst b/source/The-ROS2-Project/Contributing.rst index 23a407f861a..9e35202e4e6 100644 --- a/source/The-ROS2-Project/Contributing.rst +++ b/source/The-ROS2-Project/Contributing.rst @@ -47,7 +47,7 @@ Discussions and support ----------------------- Some of the easiest ways to contribute to ROS 2 involve engaging in community discussions and support. -You can find more information on how to pitch in on the :doc:`Contact <../../Contact>` page. +You can find more information on how to pitch in on the :doc:`Contact <../Contact>` page. Contributing code ----------------- diff --git a/source/Tutorials/Advanced/Simulators/Ignition.rst b/source/Tutorials/Advanced/Simulators/Ignition.rst index 3561d9d3a19..59c3880b017 100644 --- a/source/Tutorials/Advanced/Simulators/Ignition.rst +++ b/source/Tutorials/Advanced/Simulators/Ignition.rst @@ -26,7 +26,7 @@ You have two options: - Install from deb packages. To check which versions are available from deb packages please check this `table `__. - Compile from sources: - - :doc:`ROS 2 install instructions <../../../../Installation>` + - :doc:`ROS 2 install instructions <../../../Installation>` - `Ignition install instructions `__ Tasks diff --git a/source/Tutorials/Intermediate/Monitoring-For-Parameter-Changes-CPP.rst b/source/Tutorials/Intermediate/Monitoring-For-Parameter-Changes-CPP.rst index 137c018fcb9..faab774d980 100644 --- a/source/Tutorials/Intermediate/Monitoring-For-Parameter-Changes-CPP.rst +++ b/source/Tutorials/Intermediate/Monitoring-For-Parameter-Changes-CPP.rst @@ -2,6 +2,8 @@ Tutorials/Monitoring-For-Parameter-Changes-CPP +.. _intermediate_monitor_parameters: + Monitoring for parameter changes (C++) ======================================