Skip to content

Commit

Permalink
[Doc] Update https://index.ros.org/* in the repo (#982)
Browse files Browse the repository at this point in the history
  • Loading branch information
minggangw authored Jul 24, 2024
1 parent 9d5faf6 commit bfed3ae
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

1.Install ROS 2 from binary package.

ROS 2 is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed against the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS 2. You can download the latest binary packages from [ROS 2 build farm](http://ci.ros2.org/view/packaging/) and follow the instructions of [Linux](https://index.ros.org/doc/ros2/Installation/Linux-Install-Binary/)/[macOS](https://index.ros.org/doc/ros2/Installation/OSX-Install-Binary/)/[Windows](https://index.ros.org/doc/ros2/Installation/Windows-Install-Binary/) to setup the environment (If you want to run your apps on a stable release of ROS 2, e.g. crystal-clemmys, please see the section `Running on Stable Release of ROS 2).
ROS 2 is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed against the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS 2. You can download the latest binary packages from [ROS 2 build farm](http://ci.ros2.org/view/packaging/) and follow the instructions of [Linux](https://docs.ros.org/en/rolling/Installation/Ubuntu-Install-Debians.html)/[Windows](https://docs.ros.org/en/rolling/Installation/Windows-Install-Binary.html) to setup the environment (If you want to run your apps on a stable release of ROS 2, e.g. crystal-clemmys, please see the section `Running on Stable Release of ROS 2).

2.Build ROS 2 from scratch.

Alternatively, you can build ROS 2 from scratch. Please select the platform you want to work on, then reference the instructions of [Linux](https://index.ros.org/doc/ros2/Installation/Linux-Development-Setup/)/[macOS](https://index.ros.org/doc/ros2/Installation/OSX-Development-Setup/)/[Windows](https://index.ros.org/doc/ros2/Installation/Windows-Development-Setup/) to build ROS 2 (please build with flag `--merge-install`).
Alternatively, you can build ROS 2 from scratch. Please select the platform you want to work on, then reference the instructions of [Linux](https://docs.ros.org/en/rolling/Installation/Alternatives/Ubuntu-Development-Setup.html#)/[Windows](https://docs.ros.org/en/rolling/Installation/Alternatives/Windows-Development-Setup.html) to build ROS 2 (please build with flag `--merge-install`).

### Install `Node.js`

Expand Down
4 changes: 2 additions & 2 deletions lib/action/client.js
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ class ActionClient extends Entity {
* Send a goal and wait for the goal ACK asynchronously.
*
* Return a Promise object that is resolved with a ClientGoalHandle when receipt of the goal
* is acknowledged by an action server, see client state transition https://index.ros.org/doc/ros2/Tutorials/Understanding-ROS2-Actions/
* is acknowledged by an action server, see client state transition https://docs.ros.org/en/jazzy/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Actions/Understanding-ROS2-Actions.html
*
* @param {object} goal - The goal request.
* @param {function} feedbackCallback - Callback function for feedback associated with the goal.
Expand Down Expand Up @@ -307,7 +307,7 @@ class ActionClient extends Entity {
/**
* Get the result of an active goal asynchronously.
*
* Return a Promise object that is resolved with result, see client state transition https://index.ros.org/doc/ros2/Tutorials/Understanding-ROS2-Actions/
* Return a Promise object that is resolved with result, see client state transition https://docs.ros.org/en/jazzy/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Actions/Understanding-ROS2-Actions.html
*
* @ignore
* @param {ClientGoalHandle} goalHandle - Handle to the goal to cancel.
Expand Down
4 changes: 2 additions & 2 deletions scripts/npmjs-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ rclnodejs.init().then(() => {

**ROS 2 SDK**

- See the ROS 2 SDK [Installation Guide](https://index.ros.org/doc/ros2/Installation/) for details.
- **DON'T FORGET TO [SOURCE THE ROS 2 STARTUP FILES](https://index.ros.org/doc/ros2/Tutorials/Configuring-ROS2-Environment/#source-the-setup-files)**
- See the ROS 2 SDK [Installation Guide](https://docs.ros.org/en/jazzy/Installation.html) for details.
- **DON'T FORGET TO [SOURCE THE ROS 2 STARTUP FILES](https://docs.ros.org/en/jazzy/Tutorials/Beginner-CLI-Tools/Configuring-ROS2-Environment.html#source-the-setup-files)**

## Install rclnodejs

Expand Down
2 changes: 1 addition & 1 deletion types/action_client.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ declare module 'rclnodejs' {
* Send a goal and wait for the goal ACK asynchronously.
*
* Return a Promise object that is resolved with a ClientGoalHandle when receipt of the goal
* is acknowledged by an action server, see client state transition https://index.ros.org/doc/ros2/Tutorials/Understanding-ROS2-Actions/
* is acknowledged by an action server, see client state transition https://docs.ros.org/en/jazzy/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Actions/Understanding-ROS2-Actions.html
*
* @param goal - The goal request.
* @param feedbackCallback - Callback function for feedback associated with the goal.
Expand Down

0 comments on commit bfed3ae

Please sign in to comment.