diff --git a/blueprint/ros_integration.md b/blueprint/ros_integration.md index be30d83f92..520865f38f 100644 --- a/blueprint/ros_integration.md +++ b/blueprint/ros_integration.md @@ -101,4 +101,4 @@ The screenshot shows all the shell windows and their expected content (it was taken using ROS Melodic): -![Ignition Transport images and ROS 1 rqt](../acropolis/images/bridge_image_exchange_ign-gazebo.png) +![Ignition Transport images and ROS 1 rqt](img/bridge_image_exchange_gz-sim.png) diff --git a/citadel/index.yaml b/citadel/index.yaml index f58d5ec5d0..f293b7a473 100644 --- a/citadel/index.yaml +++ b/citadel/index.yaml @@ -41,6 +41,9 @@ pages: - name: troubleshooting title: Troubleshooting file: troubleshooting.md + - name: ign_docker_env + title: Dockerized Dev Env + file: ign_docker_env.md - name: comparison title: Feature Comparison file: comparison.md diff --git a/citadel/install_osx_src.md b/citadel/install_osx_src.md index 75f98471d5..8d94196878 100644 --- a/citadel/install_osx_src.md +++ b/citadel/install_osx_src.md @@ -122,7 +122,7 @@ If you want to compile Ignition Libraries in MacOS Catalina (10.15) you will nee Create a file called `intern.patch` with the following content: -```patch +```diff --- intern.h 2019-12-16 18:17:08.000000000 +0100 +++ /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.15.sdk/System/Library/Frameworks/Ruby.framework/Headers/ruby/ruby/intern.h @@ -14,6 +14,10 @@ @@ -140,7 +140,7 @@ Create a file called `intern.patch` with the following content: Now we can apply the patch: -```{.sh} +```sh sudo patch -p0 < intern.patch ``` @@ -164,7 +164,7 @@ Create a file called `config.patch` with the following content: Now we can appply the patch: -```{.sh} +```sh sudo patch -p0 < config.patch ``` diff --git a/citadel/ros_integration.md b/citadel/ros_integration.md index 460a698549..22184cefa4 100644 --- a/citadel/ros_integration.md +++ b/citadel/ros_integration.md @@ -96,4 +96,4 @@ The screenshot shows all the shell windows and their expected content (it was taken using ROS Melodic): -![Ignition Transport images and ROS 1 rqt](../acropolis/images/bridge_image_exchange_ign-gazebo.png) +![Ignition Transport images and ROS 1 rqt](img/bridge_image_exchange_ign-gazebo.png) diff --git a/citadel/sensors.md b/citadel/sensors.md index c5f8f101fe..34d0e120a8 100644 --- a/citadel/sensors.md +++ b/citadel/sensors.md @@ -362,14 +362,14 @@ Inside the main we subscribe to the `lidar` topic, and wait until the node is sh Download the [CMakeLists.txt](https://github.com/ignitionrobotics/docs/blob/master/citadel/tutorials/sensors/CMakeLists.txt), and in the same folder of `lidar_node` create `build/` directory: -```{.sh} +```sh mkdir build cd build ``` Run cmake and build the code: -```{.sh} +```sh cmake .. make lidar_node ``` @@ -378,13 +378,13 @@ make lidar_node Run the node from terminal 1: -```{.sh} +```sh ./build/lidar_node ``` Run the world from terminal 2: -```{.sh} +```sh ign gazebo sensor_tutorial.sdf ``` @@ -413,7 +413,7 @@ The first command is `ign gazebo sensor_tutorial.sdf` which launches the world. And the second command is `./build/lidar_node` which runs the `lidar_node`. Save the file as `sensor_launch.ign`, and then run it using the following command: -```{.sh} +```sh ign launch sensor_launch.ign ``` diff --git a/dome/install_osx_src.md b/dome/install_osx_src.md index 163d3dc340..2c4e5ceae0 100644 --- a/dome/install_osx_src.md +++ b/dome/install_osx_src.md @@ -140,7 +140,7 @@ Create a file called `intern.patch` with the following content: Now we can apply the patch: -```{.sh} +```sh sudo patch -p0 < intern.patch ``` @@ -164,7 +164,7 @@ Create a file called `config.patch` with the following content: Now we can appply the patch: -```{.sh} +```sh sudo patch -p0 < config.patch ``` diff --git a/dome/sensors.md b/dome/sensors.md index 159cdf5559..6bb641cfd8 100644 --- a/dome/sensors.md +++ b/dome/sensors.md @@ -378,13 +378,13 @@ make lidar_node Run the node from terminal 1: -```{.sh} +```sh ./build/lidar_node ``` Run the world from terminal 2: -```{.sh} +```sh ign gazebo sensor_tutorial.sdf ``` @@ -413,7 +413,7 @@ The first command is `ign gazebo sensor_tutorial.sdf` which launches the world. And the second command is `./build/lidar_node` which runs the `lidar_node`. Save the file as `sensor_launch.ign`, and then run it using the following command: -```{.sh} +```sh ign launch sensor_launch.ign ``` diff --git a/edifice/install_osx_src.md b/edifice/install_osx_src.md index d476c1054f..5bb5b06add 100644 --- a/edifice/install_osx_src.md +++ b/edifice/install_osx_src.md @@ -122,7 +122,7 @@ If you want to compile Ignition Libraries in MacOS Catalina (10.15) you will nee Create a file called `intern.patch` with the following content: -```patch +```diff --- intern.h 2019-12-16 18:17:08.000000000 +0100 +++ /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.15.sdk/System/Library/Frameworks/Ruby.framework/Headers/ruby/ruby/intern.h @@ -14,6 +14,10 @@ @@ -140,7 +140,7 @@ Create a file called `intern.patch` with the following content: Now we can apply the patch: -```{.sh} +```sh sudo patch -p0 < intern.patch ``` @@ -164,7 +164,7 @@ Create a file called `config.patch` with the following content: Now we can appply the patch: -```{.sh} +```sh sudo patch -p0 < config.patch ``` diff --git a/edifice/sensors.md b/edifice/sensors.md index ef80024ef0..22b560c77b 100644 --- a/edifice/sensors.md +++ b/edifice/sensors.md @@ -362,14 +362,14 @@ Inside the main we subscribe to the `lidar` topic, and wait until the node is sh Download the [CMakeLists.txt](https://github.com/ignitionrobotics/docs/blob/master/edifice/tutorials/sensors/CMakeLists.txt), and in the same folder of `lidar_node` create `build/` directory: -```{.sh} +```sh mkdir build cd build ``` Run cmake and build the code: -```{.sh} +```sh cmake .. make lidar_node ``` @@ -378,13 +378,13 @@ make lidar_node Run the node from terminal 1: -```{.sh} +```sh ./build/lidar_node ``` Run the world from terminal 2: -```{.sh} +```sh ign gazebo sensor_tutorial.sdf ``` @@ -413,7 +413,7 @@ The first command is `ign gazebo sensor_tutorial.sdf` which launches the world. And the second command is `./build/lidar_node` which runs the `lidar_node`. Save the file as `sensor_launch.ign`, and then run it using the following command: -```{.sh} +```sh ign launch sensor_launch.ign ``` diff --git a/fortress/install_osx_src.md b/fortress/install_osx_src.md index 085315f7da..11406f0361 100644 --- a/fortress/install_osx_src.md +++ b/fortress/install_osx_src.md @@ -122,7 +122,7 @@ If you want to compile Ignition Libraries in MacOS Catalina (10.15) you will nee Create a file called `intern.patch` with the following content: -```patch +```diff --- intern.h 2019-12-16 18:17:08.000000000 +0100 +++ /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.15.sdk/System/Library/Frameworks/Ruby.framework/Headers/ruby/ruby/intern.h @@ -14,6 +14,10 @@ @@ -140,7 +140,7 @@ Create a file called `intern.patch` with the following content: Now we can apply the patch: -```{.sh} +```sh sudo patch -p0 < intern.patch ``` @@ -148,7 +148,7 @@ sudo patch -p0 < intern.patch Create a file called `config.patch` with the following content: -```patch +```diff --- config.h 2019-12-16 18:19:13.000000000 +0100 +++ /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.15.sdk/System/Library/Frameworks/Ruby.framework/Headers/ruby/ruby/config.h @@ -410,6 +410,6 @@ @@ -164,7 +164,7 @@ Create a file called `config.patch` with the following content: Now we can appply the patch: -```{.sh} +```sh sudo patch -p0 < config.patch ``` diff --git a/fortress/sensors.md b/fortress/sensors.md index bfa6d5ccf4..2ac11c522a 100644 --- a/fortress/sensors.md +++ b/fortress/sensors.md @@ -384,14 +384,14 @@ Inside the main we subscribe to the `lidar` topic, and wait until the node is sh Download the [CMakeLists.txt](https://github.com/ignitionrobotics/docs/blob/master/fortress/tutorials/sensors/CMakeLists.txt), and in the same folder of `lidar_node` create `build/` directory: -```{.sh} +```sh mkdir build cd build ``` Run cmake and build the code: -```{.sh} +```sh cmake .. make lidar_node ``` @@ -400,13 +400,13 @@ make lidar_node Run the node from terminal 1: -```{.sh} +```sh ./build/lidar_node ``` Run the world from terminal 2: -```{.sh} +```sh ign gazebo sensor_tutorial.sdf ``` @@ -435,7 +435,7 @@ The first command is `ign gazebo sensor_tutorial.sdf` which launches the world. And the second command is `./build/lidar_node` which runs the `lidar_node`. Save the file as `sensor_launch.ign`, and then run it using the following command: -```{.sh} +```sh ign launch sensor_launch.ign ``` diff --git a/garden/install_osx_src.md b/garden/install_osx_src.md index af52e3a293..91ae8c95c3 100644 --- a/garden/install_osx_src.md +++ b/garden/install_osx_src.md @@ -136,7 +136,7 @@ If you want to compile Gazebo Libraries in MacOS Catalina (10.15) you will need Create a file called `intern.patch` with the following content: -```patch +```diff --- intern.h 2019-12-16 18:17:08.000000000 +0100 +++ /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.15.sdk/System/Library/Frameworks/Ruby.framework/Headers/ruby/ruby/intern.h @@ -14,6 +14,10 @@ @@ -154,7 +154,7 @@ Create a file called `intern.patch` with the following content: Now we can apply the patch: -```{.sh} +```sh sudo patch -p0 < intern.patch ``` @@ -162,7 +162,7 @@ sudo patch -p0 < intern.patch Create a file called `config.patch` with the following content: -```patch +```diff --- config.h 2019-12-16 18:19:13.000000000 +0100 +++ /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.15.sdk/System/Library/Frameworks/Ruby.framework/Headers/ruby/ruby/config.h @@ -410,6 +410,6 @@ @@ -178,7 +178,7 @@ Create a file called `config.patch` with the following content: Now we can appply the patch: -```{.sh} +```sh sudo patch -p0 < config.patch ``` diff --git a/garden/migration_from_ignition.md b/garden/migration_from_ignition.md index 07ad69c901..b0fe2a9f67 100644 --- a/garden/migration_from_ignition.md +++ b/garden/migration_from_ignition.md @@ -239,7 +239,7 @@ In `CMakeLists.txt` files (and their references in your source files!): **Variables and macro/function calls** -```cpp +``` Find: IGN(ITION)?_GAZEBO Replace: GZ_SIM @@ -255,7 +255,7 @@ Replace: gz_ **Includes** -```cpp +``` Find: include\(Ign Replace: include(Gz @@ -271,7 +271,7 @@ Replace: gz_find_package(Gz- **Project Names** -```cpp +``` Find: ignition-gazebo Replace: gz-sim @@ -288,7 +288,7 @@ Replace: gz- Migrate source macros and environment variables -```cpp +``` Find: IGN(ITION)?_GAZEBO Replace: GZ_SIM @@ -319,7 +319,7 @@ Additionally, the logging macros have also been migrated! Migrate any uses! In `.sdf` files: -```cpp +``` Find: **NOTE** > As Gazebo GUI is not yet working, running `gz sim` will not work. You can run only the server with -> ```cmd +> ```batch > gz sim -s -v > ``` @@ -152,7 +152,7 @@ page to start using Gazebo! > If your username contains spaces (which is quite common on Windows), you will probably get errors > saying `Invalid partition name [Computer:My User With Spaces]`. Fix this by changing `GZ_PARTITION` > to something else: -> ```cmd +> ```batch > set GZ_PARTITION=test > ``` > Remember to set the same partition in all other consoles. diff --git a/ionic/migration_from_ignition.md b/ionic/migration_from_ignition.md index 6798db1d87..5d0eafa300 100644 --- a/ionic/migration_from_ignition.md +++ b/ionic/migration_from_ignition.md @@ -239,7 +239,7 @@ In `CMakeLists.txt` files (and their references in your source files!): **Variables and macro/function calls** -```cpp +``` Find: IGN(ITION)?_GAZEBO Replace: GZ_SIM @@ -255,7 +255,7 @@ Replace: gz_ **Includes** -```cpp +``` Find: include\(Ign Replace: include(Gz @@ -271,7 +271,7 @@ Replace: gz_find_package(Gz- **Project Names** -```cpp +``` Find: ignition-gazebo Replace: gz-sim @@ -288,7 +288,7 @@ Replace: gz- Migrate source macros and environment variables -```cpp +``` Find: IGN(ITION)?_GAZEBO Replace: GZ_SIM @@ -319,7 +319,7 @@ Additionally, the logging macros have also been migrated! Migrate any uses! In `.sdf` files: -```cpp +``` Find: