diff --git a/base_conf.py b/base_conf.py index b29260d9d..f8781731c 100644 --- a/base_conf.py +++ b/base_conf.py @@ -44,7 +44,6 @@ ] myst_heading_anchors = 4 -myst_all_links_external = True myst_enable_extensions = [ "amsmath", @@ -64,6 +63,7 @@ "tasklist", ] +nitpicky = True # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/blueprint/GUI_tutorial.md b/blueprint/GUI_tutorial.md index 32dcf20c5..a674a5c15 100644 --- a/blueprint/GUI_tutorial.md +++ b/blueprint/GUI_tutorial.md @@ -4,9 +4,9 @@ This guide is an introduction to the Ignition Graphical User Interface (GUI). ## Prerequisites -Before beginning, you should have [Ignition installed](/docs/blueprint/install). -If you installed [from source](/docs/blueprint/install#option-3-source-installation-any-platform-) -you will need to [source](/docs/blueprint/install#using-the-workspace) the workspace; +Before beginning, you should have [Ignition installed](install). +If you installed [from source](install.md#option-3-source-installation-any-platform) +you will need to [source](install.md#using-the-workspace) the workspace; otherwise, you're good to go! Start by getting Ignition up and running with a sample world: @@ -104,4 +104,4 @@ The function of the World Control options will become clearer once you begin man ## Next Up -Now that you're comfortable with Ignition GUI navigation and terminology, let's start learning about more meaningful model interactions with the [Manipulating Models](/docs/blueprint/manipulating_models) tutorial. +Now that you're comfortable with Ignition GUI navigation and terminology, let's start learning about more meaningful model interactions with the [Manipulating Models](manipulating_models) tutorial. diff --git a/blueprint/Manipulating_models.md b/blueprint/Manipulating_models.md index e0f42b8ce..c3a824f5d 100644 --- a/blueprint/Manipulating_models.md +++ b/blueprint/Manipulating_models.md @@ -3,7 +3,7 @@ This tutorial will walk you through using various plugins to assist model and scene manipulation in the Ignition GUI. The Transform Control plugin is a combination of keybindings and transform control options: selection, translation, rotation and custom snap values. -This chart of [Ignition's keyboard shortcuts](/docs/blueprint/hotkeys) may be helpful for this tutorial. +This chart of [Ignition's keyboard shortcuts](hotkeys) may be helpful for this tutorial. The View Angle plugin allows you to quickly and easily adjust the direction from which your scene faces an entity in the simulation. @@ -17,7 +17,7 @@ Start by getting Ignition up and running with a sample world: ign gazebo shapes.sdf ``` -The previous tutorial, [Understanding the GUI](/docs/blueprint/gui), explains the basics of navigating the Ignition GUI. +The previous tutorial, [Understanding the GUI](gui), explains the basics of navigating the Ignition GUI. ## Transform Control @@ -130,4 +130,4 @@ You can also select multiple entities to face simultaneously from each view angl So far you've interacted with basic shape models to learn about Ignition's GUI. It's also possible to insert more detailed models from [Ignition Fuel](https://app.gazebosim.org) into the GUI. -Check out the [Model Insertion from Fuel](/docs/blueprint/fuel_insert) tutorial to learn how. +Check out the [Model Insertion from Fuel](fuel_insert) tutorial to learn how. diff --git a/blueprint/Model_insertion_fuel.md b/blueprint/Model_insertion_fuel.md index a988d3ca8..e0d170d05 100644 --- a/blueprint/Model_insertion_fuel.md +++ b/blueprint/Model_insertion_fuel.md @@ -11,7 +11,7 @@ Start by getting Ignition up and running with an empty world: ign gazebo empty.sdf ``` -The previous tutorial, [Manipulating Models](/docs/blueprint/manipulating_models), shows you how to interact with models, which might be helpful once you add some Fuel models to your world. +The previous tutorial, [Manipulating Models](manipulating_models), shows you how to interact with models, which might be helpful once you add some Fuel models to your world. ## Choose a Model diff --git a/blueprint/img/bridge_image_exchange_gz-sim.png b/blueprint/img/bridge_image_exchange_gz-sim.png new file mode 100644 index 000000000..5d71c60d1 Binary files /dev/null and b/blueprint/img/bridge_image_exchange_gz-sim.png differ diff --git a/ci.md b/ci.md index 2698996a8..6e268fe26 100644 --- a/ci.md +++ b/ci.md @@ -6,7 +6,7 @@ This document covers all the CI jobs that are available for Gazebo and how to interpret their results. This documentation assumes you have gone over the -[Contributing guide](https://gazebosim.org/docs/all/contributing) and +[Contributing guide](contributing) and therefore are familiar with: * Opening pull requests diff --git a/citadel/GUI_tutorial.md b/citadel/GUI_tutorial.md index 330fb3ee7..d70b153bb 100644 --- a/citadel/GUI_tutorial.md +++ b/citadel/GUI_tutorial.md @@ -4,9 +4,9 @@ This guide is an introduction to the Ignition Graphical User Interface (GUI). ## Prerequisites -Before beginning, you should have [Ignition installed](/docs/citadel/install). -If you installed [from source](/docs/citadel/install#source-installation-instructions) -you will need to [source](/docs/citadel/install_ubuntu_src#using-the-workspace) the workspace; +Before beginning, you should have [Ignition installed](install). +If you installed [from source](install.md#source-installation-instructions) +you will need to [source](install_ubuntu_src.md#using-the-workspace) the workspace; otherwise, you're good to go! Start by getting Ignition up and running with a sample world: diff --git a/citadel/ign_docker_env.md b/citadel/ign_docker_env.md index bd4c4bc38..07cd1279b 100644 --- a/citadel/ign_docker_env.md +++ b/citadel/ign_docker_env.md @@ -23,9 +23,9 @@ High level instructions: 1. Create a workspace with the source to mount into a container using `vcstool` 2. Use `gzdev ign-docker-env` to build and start a container with `--vol` pointing to the previously created workspace -3. See [Ubuntu Source Install section on building](install_ubuntu_src#building-the-ignition-libraries) for instructions to work with a source install -4. Consider [Contributing](/docs/all/contributing) +3. See [Ubuntu Source Install section on building](install_ubuntu_src.md#building-the-ignition-libraries) for instructions to work with a source install +4. Consider [Contributing](contributing) ## Troubleshooting -See [Troubleshooting](/docs/fortress/troubleshooting) +See [Troubleshooting](troubleshooting) diff --git a/citadel/img/bridge_image_exchange_ign-gazebo.png b/citadel/img/bridge_image_exchange_ign-gazebo.png new file mode 100644 index 000000000..a2c020fbd Binary files /dev/null and b/citadel/img/bridge_image_exchange_ign-gazebo.png differ diff --git a/citadel/install.md b/citadel/install.md index d23698b28..1e60d6085 100644 --- a/citadel/install.md +++ b/citadel/install.md @@ -43,7 +43,7 @@ collection assures that all libraries are compatible and can be used together. ## Supported platforms -Citadel is [supported](/docs/all/releases) on the platforms below. +Citadel is [supported](releases) on the platforms below. These are the **officially** supported platforms: diff --git a/citadel/install_osx.md b/citadel/install_osx.md index 63e2b2345..cbb8f45ce 100644 --- a/citadel/install_osx.md +++ b/citadel/install_osx.md @@ -16,7 +16,7 @@ brew install ignition-citadel All libraries should be ready to use and the `ign gazebo` app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling binary install @@ -30,4 +30,4 @@ brew uninstall ignition-citadel ## Troubleshooting -See [Troubleshooting](/docs/citadel/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/citadel/install_osx_src.md b/citadel/install_osx_src.md index 8c9b78eda..4ca6a9fef 100644 --- a/citadel/install_osx_src.md +++ b/citadel/install_osx_src.md @@ -232,7 +232,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -248,4 +248,4 @@ sudo make uninstall ## Troubleshooting -See [Troubleshooting](/docs/citadel/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/citadel/install_ubuntu.md b/citadel/install_ubuntu.md index ed5332824..4784199a6 100644 --- a/citadel/install_ubuntu.md +++ b/citadel/install_ubuntu.md @@ -23,7 +23,7 @@ sudo apt-get install ignition-citadel All libraries should be ready to use and the `ign gazebo` app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling binary install @@ -37,4 +37,4 @@ sudo apt remove ignition-citadel && sudo apt autoremove ## Troubleshooting -See [Troubleshooting](/docs/citadel/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/citadel/install_ubuntu_src.md b/citadel/install_ubuntu_src.md index f0a22b24d..829718a98 100644 --- a/citadel/install_ubuntu_src.md +++ b/citadel/install_ubuntu_src.md @@ -217,7 +217,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -242,4 +242,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/citadel/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/citadel/install_windows.md b/citadel/install_windows.md index fe6511f57..4a8ae977d 100644 --- a/citadel/install_windows.md +++ b/citadel/install_windows.md @@ -82,4 +82,4 @@ conda uninstall libignition- --channel conda-forge ## Troubleshooting -See [Troubleshooting](/docs/citadel/troubleshooting) +See [Troubleshooting](troubleshooting) diff --git a/citadel/install_windows_src.md b/citadel/install_windows_src.md index 9efd1a84a..8c9b9c76b 100644 --- a/citadel/install_windows_src.md +++ b/citadel/install_windows_src.md @@ -116,7 +116,7 @@ Run the following command to source the workspace: call install\setup.bat ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -142,4 +142,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/citadel/troubleshooting) +See [Troubleshooting](troubleshooting) diff --git a/citadel/ros2_integration.md b/citadel/ros2_integration.md index 917c6892f..eef8e270d 100644 --- a/citadel/ros2_integration.md +++ b/citadel/ros2_integration.md @@ -10,7 +10,7 @@ from ROS and apply it to Ignition and vice versa. ## Requirements -Please follow the [Install Gazebo and ROS document](docs/latest/ros_installation) +Please follow the [Install Gazebo and ROS document](ros_installation) before starting this tutorial. A working installation of ROS 2 and Gazebo is required to go further. diff --git a/citadel/tutorials.md b/citadel/tutorials.md index ce15849f5..7579b4c08 100644 --- a/citadel/tutorials.md +++ b/citadel/tutorials.md @@ -24,23 +24,23 @@ These tutorials cover general concepts to help get you started with Ignition. ## Per-library tutorials -See the *API & Tutorials* sections on the [Libraries page](/libs) page for more specific content correlating to each Gazebo library. +See the *API & Tutorials* sections on the [Libraries page](/libs){.external} page for more specific content correlating to each Gazebo library. The entrypoint library is Sim. -- [Sim](/api/sim/3/tutorials.html) +- [Sim](/api/sim/3/tutorials.html){.external} Other libraries: -- [Cmake](/api/cmake/2/tutorials.html) -- [Common](/api/common/3/tutorials.html) -- [Fuel_tools](/api/fuel_tools/4/tutorials.html) -- [Gui](/api/gui/3/tutorials.html) -- [Launch](/api/launch/2/tutorials.html) -- [Math](/api/math/6/tutorials.html) -- [Msgs](/api/msgs/5/tutorials.html) -- [Physics](/api/physics/2/tutorials.html) -- [Plugin](/api/plugin/1/tutorials.html) -- [Rendering](/api/rendering/3/tutorials.html) -- [Sensors](/api/sensors/3/tutorials.html) -- [Tools](/api/tools/1/tutorials.html) -- [Transport](/api/transport/8/tutorials.html) -- [Sdformat](/api/sdformat/9/) +- [Cmake](/api/cmake/2/tutorials.html){.external} +- [Common](/api/common/3/tutorials.html){.external} +- [Fuel_tools](/api/fuel_tools/4/tutorials.html){.external} +- [Gui](/api/gui/3/tutorials.html){.external} +- [Launch](/api/launch/2/tutorials.html){.external} +- [Math](/api/math/6/tutorials.html){.external} +- [Msgs](/api/msgs/5/tutorials.html){.external} +- [Physics](/api/physics/2/tutorials.html){.external} +- [Plugin](/api/plugin/1/tutorials.html){.external} +- [Rendering](/api/rendering/3/tutorials.html){.external} +- [Sensors](/api/sensors/3/tutorials.html){.external} +- [Tools](/api/tools/1/tutorials.html){.external} +- [Transport](/api/transport/8/tutorials.html){.external} +- [Sdformat](/api/sdformat/9/){.external} diff --git a/conf.py b/conf.py index 90826971f..fd39723e2 100644 --- a/conf.py +++ b/conf.py @@ -111,8 +111,12 @@ def config_init(app: Sphinx, config: Config): try: releases = load_releases(config.gz_root_index_file) - app.config.html_context["release_info"] = releases[config.gz_release] + release_info = releases[config.gz_release] + app.config.html_context["release_info"] = release_info app.config.html_context["preferred_release"] = get_preferred_release(releases) + if release_info.get('eol', False): + print(f"Disable nitpicky for {release_info['name']}") + app.config.nitpick_ignore_regex.append(("myst", r".*")) except KeyError as e: print(e) diff --git a/contributing.md b/contributing.md index 0c5459a25..4dc526db8 100644 --- a/contributing.md +++ b/contributing.md @@ -62,7 +62,7 @@ classes and functions with minimal dependencies. Documents describing the architecture of Gazebo are listed here: -* [Gazebo Sim Architecture](/docs/all/architecture) +* [Gazebo Sim Architecture](architecture) ## How to Contribute @@ -71,7 +71,7 @@ Documents describing the architecture of Gazebo are listed here: **Before Submitting a Bug Report** 1. Check the [questions and answers forum](http://answers.gazebosim.org). Your issue may have already been resolved. -2. Determine [the repository](https://gazebosim.org/docs/all/contributing#repository-list) which should receive the problem. +2. Determine [the repository](contributing.md#repository-list) which should receive the problem. 3. Search the repository's issues to see if the same or similar problem has been opened. If it has and the issue is still open, then add a comment to the existing issue. Otherwise, create a new issue. @@ -88,7 +88,7 @@ Guide](http://sscce.org/) as well as the following tips: * **Provide specific examples to demonstrate the steps.** Include links to files or projects, or copy/pasteable snippets, which you use in those examples. * **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. * **Explain which behavior you expected to see instead and why**. -* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. See [Creating GIFs](https://gazebosim.org/docs/all/contributing#creating-gifs) for GIF creation utilities. +* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. See [Creating GIFs](contributing.md#creating-gifs) for GIF creation utilities. * **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below. Provide more context by answering these questions: @@ -112,10 +112,10 @@ functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions. Before creating enhancement suggestions, please check [this -list](https://gazebosim.org/docs/all/contributing#before-submitting-an-enhancement-suggestion) as you +list](contributing.md#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as -possible](https://gazebosim.org/docs/all/contributing#how-do-i-submit-a-good-enhancement-suggestion-). +possible](contributing.md#how-do-i-submit-a-good-enhancement-suggestion). When filling in the issue form for an enhancement suggestion, include the steps that you imagine you would take if the feature you're requesting existed. @@ -124,7 +124,7 @@ existed. * **Check if you're using the latest software version**. A more recent version may contain your desired feature. * **Check if there's already [a library](https://gazebosim.org/libs) which provides that enhancement.** -* **Determine [which repository the enhancement should be suggested in](https://gazebosim.org/docs/all/contributing#repository-list).** +* **Determine [which repository the enhancement should be suggested in](contributing.md#repository-list).** * **Perform a [cursory search](https://github.com/search?q=org%3Agazebosim&type=Issues)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. * **Ask on the [community forum](https://community.gazebosim.org) about your feature.** Someone else might already have started, and you might be able to @@ -134,7 +134,7 @@ help. Enhancement suggestions are tracked as [GitHub issues](https://help.github.com/en/github/managing-your-work-on-github/about-issues). -After you've determined [which repository](https://gazebosim.org/docs/all/contributing#repository-list) +After you've determined [which repository](contributing.md#repository-list) your enhancement suggestion is related to, create an issue on that repository and provide the following information: @@ -142,7 +142,7 @@ repository and provide the following information: * **Provide a step-by-step description of the suggested enhancement** in as many details as possible. * **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks). * **Describe the current behavior** and **explain which behavior you expected to see instead** and why. -* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. See [Creating GIFs](https://gazebosim.org/docs/all/contributing#creating-gifs) for GIF creation utilities. +* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. See [Creating GIFs](contributing.md#creating-gifs) for GIF creation utilities. * **Explain why this enhancement would be useful** to most users and isn't something that can or should be implemented as a separate application. * **Specify which version of Gazebo you're using.** * **Specify the name and version of the OS you're using.** @@ -153,7 +153,7 @@ We follow a development process designed to reduce errors, encourage collaboration, and make high quality code. Review the following to get acquainted with this development process. -1. **Read the [Reporting Bugs](https://gazebosim.org/docs/all/contributing#reporting-bugs) and [Suggesting Enhancements](https://gazebosim.org/docs/all/contributing#suggesting-enhancements)** sections first. +1. **Read the [Reporting Bugs](contributing.md#reporting-bugs) and [Suggesting Enhancements](contributing.md#suggesting-enhancements)** sections first. 1. **Fork the Gazebo library** you want to contribute to. This will create your own personal copy of the library. All of your development should @@ -176,17 +176,17 @@ get acquainted with this development process. your life easier. 1. **Write your code.** This is the fun part, but is good to remember: - - Always [signoff on your commits](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository#about-commit-signoffs) (See the bullet about Developer Certificate of Origin in the [Process](https://gazebosim.org/docs/all/contributing#process) section below) + - Always [signoff on your commits](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository#about-commit-signoffs) (See the bullet about Developer Certificate of Origin in the [Process](contributing.md#process) section below) - Look at the existing code and try to maintain the existing style and pattern as much as possible - **Always** keep your branch updated with the original repository 1. **Write tests.** In most cases, a pull request will only be accepted if - it has tests. See the [Writing Tests](https://gazebosim.org/docs/all/contributing#writing-tests) + it has tests. See the [Writing Tests](contributing.md#writing-tests) section below for more information. 1. **Resolve compiler warnings.** Code must have zero compile warnings, or at least make sure your pull request is not adding new warnings. -1. **Follow the [style guide](https://gazebosim.org/docs/all/contributing#style-guides).** +1. **Follow the [style guide](contributing.md#style-guides).** Static code checking analyzes your code for bugs, such as potential memory leaks, and style. Most Gazebo libraries use the `cppcheck` static code @@ -197,7 +197,7 @@ get acquainted with this development process. To check your code, run the following script from the `build` folder of the project that you're working on. If you're working on *gz-math*, for instance, the path for the folder should be something similar to `~/citadel_ws/build/gz-math6`. - The path example is assuming you followed [our installation instructions](/docs/citadel/install) using colcon. + The path example is assuming you followed [our installation instructions](install) using colcon. Then, run the script inside this folder: @@ -208,7 +208,7 @@ get acquainted with this development process. Built target codecheck - The tool does not catch all style errors. See the [code style](https://gazebosim.org/docs/all/contributing#style-guides) section below for more information. + The tool does not catch all style errors. See the [code style](contributing.md#style-guides) section below for more information. 1. **(optional) Use clang-tidy for additional checks.** @@ -257,7 +257,7 @@ get acquainted with this development process. will be started. These jobs will build your branch on Linux, Mac and Windows, run all tests and check for warnings. - Check the [Continuous Integration guide](https://gazebosim.org/docs/all/ci) + Check the [Continuous Integration guide](ci) for information on how to interpret the results. 1. **Respond to reviewers.** At least two other people have to approve your pull request before it can be merged. Please be responsive to any questions and comments. @@ -382,7 +382,7 @@ Merging strategy: Porting changes across branches: * Pull requests should target the lowest possible - [supported version](https://gazebosim.org/docs/all/releases) where the + [supported version](releases) where the changes can be added in a backwards-compatible way (no API / ABI / behavior break in released branches). * Periodically, a maintainer will **forward-port** changes to newer release @@ -529,7 +529,7 @@ You can find more details [here](https://github.com/colcon/colcon-sanitizer-repo #### Compiling the code and running the tests Create a Gazebo workspace for ASAN/TSAN related tasks. Refer to the [offical documentation to get -all the Gazebo sources](https://gazebosim.org/docs/latest/install_ubuntu_src#getting-the-sources). +all the Gazebo sources](install_ubuntu_src.md#getting-the-sources). First, compile all packages: @@ -691,7 +691,7 @@ In general, we follow [Google's style guide](https://google.github.io/styleguide ### Releasing information for members of development team -[Releasing documentation](/docs/all/release) is available for the development team +[Releasing documentation](release) is available for the development team members. Includes a general overview as well as detailed information about how to run a new release. diff --git a/dome/GUI_tutorial.md b/dome/GUI_tutorial.md index d968e8df1..8a60ffe15 100644 --- a/dome/GUI_tutorial.md +++ b/dome/GUI_tutorial.md @@ -4,9 +4,9 @@ This guide is an introduction to the Ignition Graphical User Interface (GUI). ## Prerequisites -Before beginning, you should have [Ignition installed](/docs/dome/install). -If you installed [from source](/docs/dome/install) -you will need to [source](/docs/dome/install_ubuntu_src#using-the-workspace) the workspace; +Before beginning, you should have [Ignition installed](install). +If you installed [from source](install) +you will need to [source](install_ubuntu_src.md#using-the-workspace) the workspace; otherwise, you're good to go! Start by getting Ignition up and running with a sample world: diff --git a/dome/install.md b/dome/install.md index 93019902d..45b10af77 100644 --- a/dome/install.md +++ b/dome/install.md @@ -47,7 +47,7 @@ collection assures that all libraries are compatible and can be used together. ## Supported platforms -Dome is [supported](/docs/all/releases) on the platforms below. +Dome is [supported](releases) on the platforms below. These are the **officially** supported platforms: diff --git a/dome/install_osx.md b/dome/install_osx.md index 43e1504c0..dc5b32e2c 100644 --- a/dome/install_osx.md +++ b/dome/install_osx.md @@ -18,7 +18,7 @@ brew install ignition-dome All libraries should be ready to use and the `ign gazebo` app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling binary install @@ -32,4 +32,4 @@ brew uninstall ignition-dome ## Troubleshooting -See [Troubleshooting](/docs/dome/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/dome/install_osx_src.md b/dome/install_osx_src.md index 2c4e5ceae..f199548d5 100644 --- a/dome/install_osx_src.md +++ b/dome/install_osx_src.md @@ -226,7 +226,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -242,4 +242,4 @@ sudo make uninstall ## Troubleshooting -See [Troubleshooting](/docs/dome/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/dome/install_ubuntu.md b/dome/install_ubuntu.md index 39b1e7103..4ef2167c0 100644 --- a/dome/install_ubuntu.md +++ b/dome/install_ubuntu.md @@ -23,7 +23,7 @@ sudo apt-get install ignition-dome All libraries should be ready to use and the `ign gazebo` app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling binary install @@ -37,4 +37,4 @@ sudo apt remove ignition-dome && sudo apt autoremove ## Troubleshooting -See [Troubleshooting](/docs/dome/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/dome/install_ubuntu_src.md b/dome/install_ubuntu_src.md index 3aea0b93b..a97e6d9a8 100644 --- a/dome/install_ubuntu_src.md +++ b/dome/install_ubuntu_src.md @@ -214,7 +214,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -239,4 +239,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/dome/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/dome/install_windows.md b/dome/install_windows.md index e2582dc38..04f0aae1f 100644 --- a/dome/install_windows.md +++ b/dome/install_windows.md @@ -83,4 +83,4 @@ conda uninstall libignition- --channel conda-forge ## Troubleshooting -See [Troubleshooting](/docs/dome/troubleshooting) +See [Troubleshooting](troubleshooting) diff --git a/dome/install_windows_src.md b/dome/install_windows_src.md index b59d44cda..3869f769f 100644 --- a/dome/install_windows_src.md +++ b/dome/install_windows_src.md @@ -116,7 +116,7 @@ Run the following command to source the workspace: call install\setup.bat ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -142,4 +142,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/dome/troubleshooting) +See [Troubleshooting](troubleshooting) diff --git a/dome/tutorials.md b/dome/tutorials.md index f72c98b55..391547903 100644 --- a/dome/tutorials.md +++ b/dome/tutorials.md @@ -24,4 +24,4 @@ These tutorials cover general concepts to help get you started with Ignition. * [Actors](actors) -More specific content correlating to each Ignition library can be found under the *API & Tutorials* sections on the [Libraries page](/libs). +More specific content correlating to each Ignition library can be found under the *API & Tutorials* sections on the [Libraries page](/libs){.external}. diff --git a/edifice/GUI_tutorial.md b/edifice/GUI_tutorial.md index 793f72de2..90a242fba 100644 --- a/edifice/GUI_tutorial.md +++ b/edifice/GUI_tutorial.md @@ -4,9 +4,9 @@ This guide is an introduction to the Ignition Graphical User Interface (GUI). ## Prerequisites -Before beginning, you should have [Ignition installed](/docs/edifice/install). -If you installed [from source](/docs/edifice/install) -you will need to [source](/docs/edifice/install_ubuntu_src#using-the-workspace) the workspace; +Before beginning, you should have [Ignition installed](install). +If you installed [from source](install) +you will need to [source](install_ubuntu_src.md#using-the-workspace) the workspace; otherwise, you're good to go! Start by getting Ignition up and running with a sample world: diff --git a/edifice/install.md b/edifice/install.md index a68b19fbf..6b51c5e6c 100644 --- a/edifice/install.md +++ b/edifice/install.md @@ -48,7 +48,7 @@ collection assures that all libraries are compatible and can be used together. ## Supported platforms -Edifice is [supported](/docs/all/releases) on the platforms below. +Edifice is [supported](releases) on the platforms below. These are the **officially** supported platforms: diff --git a/edifice/install_osx.md b/edifice/install_osx.md index 5e57c6810..aea4edd70 100644 --- a/edifice/install_osx.md +++ b/edifice/install_osx.md @@ -18,7 +18,7 @@ brew install ignition-edifice All libraries should be ready to use and the `ign gazebo` app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling binary install @@ -32,4 +32,4 @@ brew uninstall ignition-edifice ## Troubleshooting -See [Troubleshooting](/docs/edifice/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/edifice/install_osx_src.md b/edifice/install_osx_src.md index 5bb5b06ad..5d860c2ec 100644 --- a/edifice/install_osx_src.md +++ b/edifice/install_osx_src.md @@ -226,7 +226,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -242,4 +242,4 @@ sudo make uninstall ## Troubleshooting -See [Troubleshooting](/docs/edifice/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/edifice/install_ubuntu.md b/edifice/install_ubuntu.md index af1642574..445392ce8 100644 --- a/edifice/install_ubuntu.md +++ b/edifice/install_ubuntu.md @@ -23,7 +23,7 @@ sudo apt-get install ignition-edifice All libraries should be ready to use and the `ign gazebo` app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling binary install @@ -37,4 +37,4 @@ sudo apt remove ignition-edifice && sudo apt autoremove ## Troubleshooting -See [Troubleshooting](/docs/edifice/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/edifice/install_ubuntu_src.md b/edifice/install_ubuntu_src.md index ea6f3e886..22507a0d4 100644 --- a/edifice/install_ubuntu_src.md +++ b/edifice/install_ubuntu_src.md @@ -214,7 +214,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -239,4 +239,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/edifice/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/edifice/install_windows.md b/edifice/install_windows.md index 1d7868839..ddfee5a12 100644 --- a/edifice/install_windows.md +++ b/edifice/install_windows.md @@ -83,4 +83,4 @@ conda uninstall libignition- --channel conda-forge ## Troubleshooting -See [Troubleshooting](/docs/edifice/troubleshooting#windows) +See [Troubleshooting](troubleshooting.md#windows) diff --git a/edifice/install_windows_src.md b/edifice/install_windows_src.md index 61b953b75..8f1f17cf5 100644 --- a/edifice/install_windows_src.md +++ b/edifice/install_windows_src.md @@ -129,7 +129,7 @@ call install\setup.bat .\install\setup.ps1 ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -155,4 +155,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/edifice/troubleshooting#windows) +See [Troubleshooting](troubleshooting.md#windows) diff --git a/edifice/tutorials.md b/edifice/tutorials.md index f72c98b55..391547903 100644 --- a/edifice/tutorials.md +++ b/edifice/tutorials.md @@ -24,4 +24,4 @@ These tutorials cover general concepts to help get you started with Ignition. * [Actors](actors) -More specific content correlating to each Ignition library can be found under the *API & Tutorials* sections on the [Libraries page](/libs). +More specific content correlating to each Ignition library can be found under the *API & Tutorials* sections on the [Libraries page](/libs){.external}. diff --git a/fortress/GUI_tutorial.md b/fortress/GUI_tutorial.md index 4255a9677..bfefc78ed 100644 --- a/fortress/GUI_tutorial.md +++ b/fortress/GUI_tutorial.md @@ -4,9 +4,9 @@ This guide is an introduction to the Ignition Graphical User Interface (GUI). ## Prerequisites -Before beginning, you should have [Ignition installed](/docs/fortress/install). -If you installed [from source](/docs/fortress/install) -you will need to [source](/docs/fortress/install_ubuntu_src#using-the-workspace) the workspace; +Before beginning, you should have [Ignition installed](install). +If you installed [from source](install) +you will need to [source](install_ubuntu_src.md#using-the-workspace) the workspace; otherwise, you're good to go! Start by getting Ignition up and running with a sample world: diff --git a/fortress/ign_docker_env.md b/fortress/ign_docker_env.md index bd4c4bc38..07cd1279b 100644 --- a/fortress/ign_docker_env.md +++ b/fortress/ign_docker_env.md @@ -23,9 +23,9 @@ High level instructions: 1. Create a workspace with the source to mount into a container using `vcstool` 2. Use `gzdev ign-docker-env` to build and start a container with `--vol` pointing to the previously created workspace -3. See [Ubuntu Source Install section on building](install_ubuntu_src#building-the-ignition-libraries) for instructions to work with a source install -4. Consider [Contributing](/docs/all/contributing) +3. See [Ubuntu Source Install section on building](install_ubuntu_src.md#building-the-ignition-libraries) for instructions to work with a source install +4. Consider [Contributing](contributing) ## Troubleshooting -See [Troubleshooting](/docs/fortress/troubleshooting) +See [Troubleshooting](troubleshooting) diff --git a/fortress/install.md b/fortress/install.md index 3803daa08..07a09c428 100644 --- a/fortress/install.md +++ b/fortress/install.md @@ -51,7 +51,7 @@ collection assures that all libraries are compatible and can be used together. ## Supported platforms -Fortress is [supported](/docs/all/releases) on the platforms below. +Fortress is [supported](releases) on the platforms below. These are the **officially** supported platforms: diff --git a/fortress/install_osx.md b/fortress/install_osx.md index b4b2016a5..c71b04d92 100644 --- a/fortress/install_osx.md +++ b/fortress/install_osx.md @@ -18,7 +18,7 @@ brew install ignition-fortress All libraries should be ready to use and the `ign gazebo -s` server app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling binary install @@ -32,4 +32,4 @@ brew uninstall ignition-fortress ## Troubleshooting -See [Troubleshooting](/docs/fortress/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/fortress/install_osx_src.md b/fortress/install_osx_src.md index 9f3ae6210..7a8db9186 100644 --- a/fortress/install_osx_src.md +++ b/fortress/install_osx_src.md @@ -232,7 +232,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -248,4 +248,4 @@ sudo make uninstall ## Troubleshooting -See [Troubleshooting](/docs/fortress/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/fortress/install_ubuntu.md b/fortress/install_ubuntu.md index a5342ce85..07829d68e 100644 --- a/fortress/install_ubuntu.md +++ b/fortress/install_ubuntu.md @@ -23,7 +23,7 @@ sudo apt-get install ignition-fortress All libraries should be ready to use and the `ign gazebo` app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling binary install @@ -37,4 +37,4 @@ sudo apt remove ignition-fortress && sudo apt autoremove ## Troubleshooting -See [Troubleshooting](/docs/fortress/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/fortress/install_ubuntu_src.md b/fortress/install_ubuntu_src.md index 226991a81..ede08fb24 100644 --- a/fortress/install_ubuntu_src.md +++ b/fortress/install_ubuntu_src.md @@ -221,7 +221,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -246,4 +246,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/fortress/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/fortress/install_windows.md b/fortress/install_windows.md index c7a83326a..654b10463 100644 --- a/fortress/install_windows.md +++ b/fortress/install_windows.md @@ -70,4 +70,4 @@ conda uninstall libignition- --channel conda-forge ## Troubleshooting -See [Troubleshooting](/docs/fortress/troubleshooting#windows) +See [Troubleshooting](troubleshooting.md#windows) diff --git a/fortress/install_windows_src.md b/fortress/install_windows_src.md index 9ec29e6c1..f52513ee3 100644 --- a/fortress/install_windows_src.md +++ b/fortress/install_windows_src.md @@ -128,7 +128,7 @@ call install\setup.bat .\install\setup.ps1 ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -154,4 +154,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/fortress/troubleshooting#windows) +See [Troubleshooting](troubleshooting.md#windows) diff --git a/fortress/ros2_integration.md b/fortress/ros2_integration.md index 460f1a20a..b2e80c5bb 100644 --- a/fortress/ros2_integration.md +++ b/fortress/ros2_integration.md @@ -12,7 +12,7 @@ Example uses of the bridge can be found in [`ros_gz_sim_demos`](https://github.c ## Requirements -Please follow the [Install Gazebo and ROS document](/docs/latest/ros_installation) +Please follow the [Install Gazebo and ROS document](ros_installation) before starting this tutorial. A working installation of ROS 2 and Gazebo is required to go further. diff --git a/fortress/ros2_interop.md b/fortress/ros2_interop.md index a4c49172d..7e9203126 100644 --- a/fortress/ros2_interop.md +++ b/fortress/ros2_interop.md @@ -10,7 +10,7 @@ Users can interact with `rrbot` through ROS 2 commands to move the robot's arms ## Prerequisites -1. A working installation of ROS 2 and Gazebo is required to go further. Please follow the [Install Gazebo and ROS document](/docs/latest/ros_installation). +1. A working installation of ROS 2 and Gazebo is required to go further. Please follow the [Install Gazebo and ROS document](ros_installation). 2. Basic familiarity with ROS concepts and terminal commands. 3. Check out [ROS 2 Integration](ros2_integration) to get familiar with [`ros_ign_bridge`](https://github.com/gazebosim/ros_gz) before starting this tutorial. diff --git a/fortress/tutorials.md b/fortress/tutorials.md index 9c4dccf3b..be499dcfd 100644 --- a/fortress/tutorials.md +++ b/fortress/tutorials.md @@ -27,24 +27,24 @@ These tutorials cover general concepts to help get you started with Ignition. ## Per-library tutorials -See the *API & Tutorials* sections on the [Libraries page](/libs) page for more specific content correlating to each Gazebo library. +See the *API & Tutorials* sections on the [Libraries page](/libs){.external} page for more specific content correlating to each Gazebo library. The entrypoint library is Sim. -- [Sim](/api/sim/6/tutorials.html) +- [Sim](/api/sim/6/tutorials.html){.external} Other libraries: -- [Cmake](/api/cmake/2/tutorials.html) -- [Common](/api/common/4/tutorials.html) -- [Fuel_tools](/api/fuel_tools/7/tutorials.html) -- [Gui](/api/gui/6/tutorials.html) -- [Launch](/api/launch/5/tutorials.html) -- [Math](/api/math/6/tutorials.html) -- [Msgs](/api/msgs/8/tutorials.html) -- [Physics](/api/physics/5/tutorials.html) -- [Plugin](/api/plugin/1/tutorials.html) -- [Rendering](/api/rendering/6/tutorials.html) -- [Sensors](/api/sensors/6/tutorials.html) -- [Tools](/api/tools/1/tutorials.html) -- [Transport](/api/transport/11/tutorials.html) -- [Utils](/api/utils/1/tutorials.html) -- [Sdformat](/api/sdformat/12/) +- [Cmake](/api/cmake/2/tutorials.html){.external} +- [Common](/api/common/4/tutorials.html){.external} +- [Fuel_tools](/api/fuel_tools/7/tutorials.html){.external} +- [Gui](/api/gui/6/tutorials.html){.external} +- [Launch](/api/launch/5/tutorials.html){.external} +- [Math](/api/math/6/tutorials.html){.external} +- [Msgs](/api/msgs/8/tutorials.html){.external} +- [Physics](/api/physics/5/tutorials.html){.external} +- [Plugin](/api/plugin/1/tutorials.html){.external} +- [Rendering](/api/rendering/6/tutorials.html){.external} +- [Sensors](/api/sensors/6/tutorials.html){.external} +- [Tools](/api/tools/1/tutorials.html){.external} +- [Transport](/api/transport/11/tutorials.html){.external} +- [Utils](/api/utils/1/tutorials.html){.external} +- [Sdformat](/api/sdformat/12/){.external} diff --git a/fuel/data_privacy_policy.md b/fuel/data_privacy_policy.md index ed294a16a..96b6e4700 100644 --- a/fuel/data_privacy_policy.md +++ b/fuel/data_privacy_policy.md @@ -33,5 +33,5 @@ or use this information for ads or marketing. Content may be immediately removed if it * contains images that do not represent the actual data, - * violates copyright law (See our [Copyright](/docs/latest/fuel_copyright) and [Fair Use](/docs/latest/fuel_fair_use) pages), or + * violates copyright law (See our [Copyright](fuel_copyright) and [Fair Use](fuel_fair_use) pages), or * contains inappropriate material including but not limited to spam, marketing material, or sexually explicit content. diff --git a/garden/GUI_tutorial.md b/garden/GUI_tutorial.md index 97125513e..f410674fa 100644 --- a/garden/GUI_tutorial.md +++ b/garden/GUI_tutorial.md @@ -4,9 +4,9 @@ This guide is an introduction to the Gazebo Graphical User Interface (GUI). ## Prerequisites -Before beginning, you should have [Garden installed](/docs/garden/install). -If you installed [from source](/docs/garden/install) -you will need to [source](/docs/garden/install_ubuntu_src#using-the-workspace) the workspace; +Before beginning, you should have [Garden installed](install). +If you installed [from source](install) +you will need to [source](install_ubuntu_src.md#using-the-workspace) the workspace; otherwise, you're good to go! Start by getting Gazebo up and running with a sample world: diff --git a/garden/Model_insertion_fuel.md b/garden/Model_insertion_fuel.md index 7cfc5fc25..9c19a4904 100644 --- a/garden/Model_insertion_fuel.md +++ b/garden/Model_insertion_fuel.md @@ -11,7 +11,7 @@ Start by getting Gazebo up and running with an empty world: gz sim empty.sdf ``` -The previous tutorial, [Manipulating Models](Manipulating_models.md), shows you how to interact with models, which might be helpful once you add some Fuel models to your world. +The previous tutorial, [Manipulating Models](manipulating_models.md), shows you how to interact with models, which might be helpful once you add some Fuel models to your world. ## Choose a Model diff --git a/garden/install.md b/garden/install.md index dfc2b83ef..51ee0d912 100644 --- a/garden/install.md +++ b/garden/install.md @@ -47,7 +47,7 @@ This list of library versions may change up to the release date. ## Supported platforms -Garden is planned to be [supported](/docs/all/releases) on the platforms below. +Garden is planned to be [supported](releases) on the platforms below. This list may change up to the release date. These are the **officially** supported platforms: diff --git a/garden/install_osx.md b/garden/install_osx.md index 252242a93..5f6c4d095 100644 --- a/garden/install_osx.md +++ b/garden/install_osx.md @@ -18,7 +18,7 @@ brew install gz-garden All libraries should be ready to use and the `gz sim -s` server app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Gazebo! ## Uninstalling binary install @@ -32,4 +32,4 @@ brew uninstall gz-garden ## Troubleshooting -See [Troubleshooting](/docs/garden/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/garden/install_osx_src.md b/garden/install_osx_src.md index 3caba545c..552d2f780 100644 --- a/garden/install_osx_src.md +++ b/garden/install_osx_src.md @@ -264,9 +264,9 @@ gz sim -v 4 shapes.sdf -s gz sim -v 4 -g ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Gazebo! ## Troubleshooting -See [Troubleshooting](/docs/garden/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/garden/install_ubuntu.md b/garden/install_ubuntu.md index 79333ddfa..c1c29b68a 100644 --- a/garden/install_ubuntu.md +++ b/garden/install_ubuntu.md @@ -30,7 +30,7 @@ sudo apt-get install gz-garden All libraries should be ready to use and the `gz sim` app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Gazebo! @@ -45,4 +45,4 @@ sudo apt remove gz-garden && sudo apt autoremove ## Troubleshooting -See [Troubleshooting](/docs/garden/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/garden/install_ubuntu_src.md b/garden/install_ubuntu_src.md index b84b8ad0a..925c93a90 100644 --- a/garden/install_ubuntu_src.md +++ b/garden/install_ubuntu_src.md @@ -173,7 +173,7 @@ colcon build --packages-select PACKAGE_NAME Visit [colcon documentation](https://colcon.readthedocs.io/en/released/#) to view more `colcon` build and test options. -If there are no errors, all the binaries should be ready to use. You can check the [Troubleshooting](/docs/garden/troubleshooting#ubuntu) section for errors. +If there are no errors, all the binaries should be ready to use. You can check the [Troubleshooting](troubleshooting.md#ubuntu) section for errors. ## Using the workspace @@ -191,7 +191,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Gazebo! ## Uninstalling source-based install @@ -216,7 +216,7 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/garden/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) ## QML Debugging diff --git a/garden/install_windows.md b/garden/install_windows.md index 4bec7897c..45808f808 100644 --- a/garden/install_windows.md +++ b/garden/install_windows.md @@ -69,4 +69,4 @@ conda uninstall libgz- --channel conda-forge ## Troubleshooting -See [Troubleshooting](/docs/garden/troubleshooting#windows) +See [Troubleshooting](troubleshooting.md#windows) diff --git a/garden/install_windows_src.md b/garden/install_windows_src.md index ad46f24b6..2e0cebc6e 100644 --- a/garden/install_windows_src.md +++ b/garden/install_windows_src.md @@ -128,7 +128,7 @@ call install\setup.bat .\install\setup.ps1 ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Gazebo! ## Uninstalling source-based install @@ -154,4 +154,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/garden/troubleshooting#windows) +See [Troubleshooting](troubleshooting.md#windows) diff --git a/garden/ros2_integration.md b/garden/ros2_integration.md index 74eb62970..e9cc0c197 100644 --- a/garden/ros2_integration.md +++ b/garden/ros2_integration.md @@ -11,7 +11,7 @@ simulatenously simulated by a Gazebo world. ## Requirements -Please follow the [Install Gazebo and ROS document](/docs/latest/ros_installation) +Please follow the [Install Gazebo and ROS document](ros_installation) before starting this tutorial. A working installation of ROS 2 and Gazebo is required to go further. diff --git a/garden/ros2_interop.md b/garden/ros2_interop.md index ff2cfdbc6..d71317310 100644 --- a/garden/ros2_interop.md +++ b/garden/ros2_interop.md @@ -10,7 +10,7 @@ Users can interact with `rrbot` through ROS 2 commands to move the robot's arms ## Prerequisites -1. A working installation of ROS 2 and Gazebo is required to go further. Please follow the [Install Gazebo and ROS document](/docs/latest/ros_installation). +1. A working installation of ROS 2 and Gazebo is required to go further. Please follow the [Install Gazebo and ROS document](ros_installation). 2. Basic familiarity with ROS concepts and terminal commands. 3. Check out [ROS 2 Integration](ros2_integration) to get familiar with [`ros_gz_bridge`](https://github.com/gazebosim/ros_gz) before starting this tutorial. diff --git a/garden/tutorials.md b/garden/tutorials.md index a1f1a18cf..29ae7d42a 100644 --- a/garden/tutorials.md +++ b/garden/tutorials.md @@ -26,24 +26,24 @@ These tutorials cover general concepts to help get you started with Gazebo. ## Per-library tutorials -See the *API & Tutorials* sections on the [Libraries page](/libs) page for more specific content correlating to each Gazebo library. +See the *API & Tutorials* sections on the [Libraries page](/libs){.external} page for more specific content correlating to each Gazebo library. The entrypoint library is Sim. -- [Sim](/api/sim/7/tutorials.html) +- [Sim](/api/sim/7/tutorials.html){.external} Other libraries: -- [Cmake](/api/cmake/3/tutorials.html) -- [Common](/api/common/5/tutorials.html) -- [Fuel_tools](/api/fuel_tools/8/tutorials.html) -- [Gui](/api/gui/7/tutorials.html) -- [Launch](/api/launch/6/tutorials.html) -- [Math](/api/math/7/tutorials.html) -- [Msgs](/api/msgs/9/tutorials.html) -- [Physics](/api/physics/6/tutorials.html) -- [Plugin](/api/plugin/2/tutorials.html) -- [Rendering](/api/rendering/7/tutorials.html) -- [Sensors](/api/sensors/7/tutorials.html) -- [Tools](/api/tools/2/tutorials.html) -- [Transport](/api/transport/12/tutorials.html) -- [Utils](/api/utils/2/tutorials.html) -- [Sdformat](/api/sdformat/13/) +- [Cmake](/api/cmake/3/tutorials.html){.external} +- [Common](/api/common/5/tutorials.html){.external} +- [Fuel_tools](/api/fuel_tools/8/tutorials.html){.external} +- [Gui](/api/gui/7/tutorials.html){.external} +- [Launch](/api/launch/6/tutorials.html){.external} +- [Math](/api/math/7/tutorials.html){.external} +- [Msgs](/api/msgs/9/tutorials.html){.external} +- [Physics](/api/physics/6/tutorials.html){.external} +- [Plugin](/api/plugin/2/tutorials.html){.external} +- [Rendering](/api/rendering/7/tutorials.html){.external} +- [Sensors](/api/sensors/7/tutorials.html){.external} +- [Tools](/api/tools/2/tutorials.html){.external} +- [Transport](/api/transport/12/tutorials.html){.external} +- [Utils](/api/utils/2/tutorials.html){.external} +- [Sdformat](/api/sdformat/13/){.external} diff --git a/get_started.md b/get_started.md index bfc8d40c6..a74a06b1b 100644 --- a/get_started.md +++ b/get_started.md @@ -9,7 +9,7 @@ simulation using Gazebo.
Note: If you are a ROS user, please first read our tutorial about - the ROS/Gazebo installation. + the ROS/Gazebo installation.
The recommended installation for new users is the use of binary @@ -98,7 +98,7 @@ This tutorial has covered the basics of getting started with Gazebo. Starting with Citadel, there are more [versioned tutorials](/docs/citadel/tutorials){.external} covering the basics of the GUI, creating worlds and robots, and more. -Each [Gazebo library](/libs) also has a set of tutorials and +Each [Gazebo library](/libs){.external} also has a set of tutorials and examples. Explore these resources, and don't forget to ask questions and find solutions at [answers.gazebosim.org](http://answers.gazebosim.org). diff --git a/harmonic/GUI_tutorial.md b/harmonic/GUI_tutorial.md index 6dc8a2d14..6183e0a58 100644 --- a/harmonic/GUI_tutorial.md +++ b/harmonic/GUI_tutorial.md @@ -4,9 +4,9 @@ This guide is an introduction to the Gazebo Graphical User Interface (GUI). ## Prerequisites -Before beginning, you should have [Harmonic installed](/docs/harmonic/install). -If you installed [from source](/docs/harmonic/install) -you will need to [source](/docs/harmonic/install_ubuntu_src#using-the-workspace) the workspace; +Before beginning, you should have [Harmonic installed](install). +If you installed [from source](install) +you will need to [source](install_ubuntu_src.md#using-the-workspace) the workspace; otherwise, you're good to go! Start by getting Gazebo up and running with a sample world: diff --git a/harmonic/Model_insertion_fuel.md b/harmonic/Model_insertion_fuel.md index 7cfc5fc25..9c19a4904 100644 --- a/harmonic/Model_insertion_fuel.md +++ b/harmonic/Model_insertion_fuel.md @@ -11,7 +11,7 @@ Start by getting Gazebo up and running with an empty world: gz sim empty.sdf ``` -The previous tutorial, [Manipulating Models](Manipulating_models.md), shows you how to interact with models, which might be helpful once you add some Fuel models to your world. +The previous tutorial, [Manipulating Models](manipulating_models.md), shows you how to interact with models, which might be helpful once you add some Fuel models to your world. ## Choose a Model diff --git a/harmonic/install.md b/harmonic/install.md index b91a9bbb5..c0f2c30e9 100644 --- a/harmonic/install.md +++ b/harmonic/install.md @@ -49,7 +49,7 @@ This list of library versions may change up to the release date. ## Supported platforms -Harmonic is planned to be [supported](/docs/all/releases) on the platforms below. +Harmonic is planned to be [supported](releases) on the platforms below. This list may change up to the release date. These are the **officially** supported platforms: diff --git a/harmonic/install_osx.md b/harmonic/install_osx.md index 8cfb02ff5..3eebe7150 100644 --- a/harmonic/install_osx.md +++ b/harmonic/install_osx.md @@ -18,7 +18,7 @@ brew install gz-harmonic All libraries should be ready to use and the `gz sim -s` server app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Gazebo! ## Uninstalling binary install @@ -32,4 +32,4 @@ brew uninstall gz-harmonic ## Troubleshooting -See [Troubleshooting](/docs/harmonic/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/harmonic/install_osx_src.md b/harmonic/install_osx_src.md index f9d1381d5..d1bfe7256 100644 --- a/harmonic/install_osx_src.md +++ b/harmonic/install_osx_src.md @@ -207,9 +207,9 @@ gz sim -v 4 shapes.sdf -s gz sim -v 4 -g ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Gazebo! ## Troubleshooting -See [Troubleshooting](/docs/harmonic/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/harmonic/install_ubuntu.md b/harmonic/install_ubuntu.md index 261846534..9091725f7 100644 --- a/harmonic/install_ubuntu.md +++ b/harmonic/install_ubuntu.md @@ -30,7 +30,7 @@ sudo apt-get install gz-harmonic All libraries should be ready to use and the `gz sim` app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Gazebo! @@ -45,4 +45,4 @@ sudo apt remove gz-harmonic && sudo apt autoremove ## Troubleshooting -See [Troubleshooting](/docs/harmonic/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/harmonic/install_ubuntu_src.md b/harmonic/install_ubuntu_src.md index 8683c9c84..04de05108 100644 --- a/harmonic/install_ubuntu_src.md +++ b/harmonic/install_ubuntu_src.md @@ -173,7 +173,7 @@ colcon build --packages-select PACKAGE_NAME Visit [colcon documentation](https://colcon.readthedocs.io/en/released/#) to view more `colcon` build and test options. -If there are no errors, all the binaries should be ready to use. You can check the [Troubleshooting](/docs/harmonic/troubleshooting#ubuntu) section for errors. +If there are no errors, all the binaries should be ready to use. You can check the [Troubleshooting](troubleshooting.md#ubuntu) section for errors. ## Using the workspace @@ -191,7 +191,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Gazebo! ## Uninstalling source-based install @@ -216,7 +216,7 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/harmonic/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) ## QML Debugging diff --git a/harmonic/install_windows.md b/harmonic/install_windows.md index f0aacc753..45808f808 100644 --- a/harmonic/install_windows.md +++ b/harmonic/install_windows.md @@ -69,4 +69,4 @@ conda uninstall libgz- --channel conda-forge ## Troubleshooting -See [Troubleshooting](/docs/harmonic/troubleshooting#windows) +See [Troubleshooting](troubleshooting.md#windows) diff --git a/harmonic/install_windows_src.md b/harmonic/install_windows_src.md index b3e3a3d5f..77e33bbd0 100644 --- a/harmonic/install_windows_src.md +++ b/harmonic/install_windows_src.md @@ -139,7 +139,7 @@ call install\setup.bat .\install\setup.ps1 ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Gazebo! > **NOTE** @@ -198,4 +198,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/harmonic/troubleshooting#windows) +See [Troubleshooting](troubleshooting.md#windows) diff --git a/harmonic/ros2_interop.md b/harmonic/ros2_interop.md index 197b832c6..077480994 100644 --- a/harmonic/ros2_interop.md +++ b/harmonic/ros2_interop.md @@ -10,7 +10,7 @@ Users can interact with `rrbot` through ROS 2 commands to move the robot's arms ## Prerequisites -1. A working installation of ROS 2 and Gazebo is required to go further. Please follow the [Install Gazebo and ROS document](/docs/latest/ros_installation). +1. A working installation of ROS 2 and Gazebo is required to go further. Please follow the [Install Gazebo and ROS document](ros_installation). 2. Basic familiarity with ROS concepts and terminal commands. 3. Check out [ROS 2 Integration](ros2_integration) to get familiar with [`ros_gz_bridge`](https://github.com/gazebosim/ros_gz) before starting this tutorial. diff --git a/harmonic/ros2_overview.md b/harmonic/ros2_overview.md index e89954970..a5d8ab62b 100644 --- a/harmonic/ros2_overview.md +++ b/harmonic/ros2_overview.md @@ -22,7 +22,7 @@ task can be performed using ROS 2. ## Requirements -Please follow the [Install Gazebo and ROS document](/docs/latest/ros_installation) +Please follow the [Install Gazebo and ROS document](ros_installation) before starting this tutorial. A working installation of ROS 2 and Gazebo is required to go further. diff --git a/harmonic/tutorials.md b/harmonic/tutorials.md index cd1103df2..facda5b02 100644 --- a/harmonic/tutorials.md +++ b/harmonic/tutorials.md @@ -26,24 +26,24 @@ These tutorials cover general concepts to help get you started with Gazebo. ## Per-library tutorials -See the *API & Tutorials* sections on the [Libraries page](/libs) page for more specific content correlating to each Gazebo library. +See the *API & Tutorials* sections on the [Libraries page](/libs){.external} page for more specific content correlating to each Gazebo library. The entrypoint library is Sim. -- [Sim](/api/sim/8/tutorials.html) +- [Sim](/api/sim/8/tutorials.html){.external} Other libraries: -- [Cmake](/api/cmake/3/tutorials.html) -- [Common](/api/common/5/tutorials.html) -- [Fuel_tools](/api/fuel_tools/9/tutorials.html) -- [Gui](/api/gui/8/tutorials.html) -- [Launch](/api/launch/7/tutorials.html) -- [Math](/api/math/7/tutorials.html) -- [Msgs](/api/msgs/10/tutorials.html) -- [Physics](/api/physics/7/tutorials.html) -- [Plugin](/api/plugin/2/tutorials.html) -- [Rendering](/api/rendering/8/tutorials.html) -- [Sensors](/api/sensors/8/tutorials.html) -- [Tools](/api/tools/2/tutorials.html) -- [Transport](/api/transport/13/tutorials.html) -- [Utils](/api/utils/2/tutorials.html) -- [Sdformat](/api/sdformat/13/) +- [Cmake](/api/cmake/3/tutorials.html){.external} +- [Common](/api/common/5/tutorials.html){.external} +- [Fuel_tools](/api/fuel_tools/9/tutorials.html){.external} +- [Gui](/api/gui/8/tutorials.html){.external} +- [Launch](/api/launch/7/tutorials.html){.external} +- [Math](/api/math/7/tutorials.html){.external} +- [Msgs](/api/msgs/10/tutorials.html){.external} +- [Physics](/api/physics/7/tutorials.html){.external} +- [Plugin](/api/plugin/2/tutorials.html){.external} +- [Rendering](/api/rendering/8/tutorials.html){.external} +- [Sensors](/api/sensors/8/tutorials.html){.external} +- [Tools](/api/tools/2/tutorials.html){.external} +- [Transport](/api/transport/13/tutorials.html){.external} +- [Utils](/api/utils/2/tutorials.html){.external} +- [Sdformat](/api/sdformat/13/){.external} diff --git a/ionic/GUI_tutorial.md b/ionic/GUI_tutorial.md index b0ab28460..946943e25 100644 --- a/ionic/GUI_tutorial.md +++ b/ionic/GUI_tutorial.md @@ -4,9 +4,9 @@ This guide is an introduction to the Gazebo Graphical User Interface (GUI). ## Prerequisites -Before beginning, you should have [Ionic installed](/docs/ionic/install). -If you installed [from source](/docs/ionic/install) -you will need to [source](/docs/ionic/install_ubuntu_src#using-the-workspace) the workspace; +Before beginning, you should have [Ionic installed](install). +If you installed [from source](install) +you will need to [source](install_ubuntu_src.md#using-the-workspace) the workspace; otherwise, you're good to go! Start by getting Gazebo up and running with a sample world: diff --git a/ionic/Model_insertion_fuel.md b/ionic/Model_insertion_fuel.md index 7cfc5fc25..9c19a4904 100644 --- a/ionic/Model_insertion_fuel.md +++ b/ionic/Model_insertion_fuel.md @@ -11,7 +11,7 @@ Start by getting Gazebo up and running with an empty world: gz sim empty.sdf ``` -The previous tutorial, [Manipulating Models](Manipulating_models.md), shows you how to interact with models, which might be helpful once you add some Fuel models to your world. +The previous tutorial, [Manipulating Models](manipulating_models.md), shows you how to interact with models, which might be helpful once you add some Fuel models to your world. ## Choose a Model diff --git a/ionic/install.md b/ionic/install.md index 6a6c6f260..406741557 100644 --- a/ionic/install.md +++ b/ionic/install.md @@ -49,7 +49,7 @@ This list of library versions may change up to the release date. ## Supported platforms -Ionic is planned to be [supported](/docs/all/releases) on the platforms below. +Ionic is planned to be [supported](releases) on the platforms below. This list may change up to the release date. These are the **officially** supported platforms: diff --git a/ionic/install_osx.md b/ionic/install_osx.md index 870c42b98..39b62016e 100644 --- a/ionic/install_osx.md +++ b/ionic/install_osx.md @@ -18,7 +18,7 @@ brew install gz-ionic All libraries should be ready to use and the `gz sim -s` server app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Gazebo! ## Uninstalling binary install @@ -32,4 +32,4 @@ brew uninstall gz-ionic ## Troubleshooting -See [Troubleshooting](/docs/ionic/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/ionic/install_osx_src.md b/ionic/install_osx_src.md index 30f40d02b..3f14e2064 100644 --- a/ionic/install_osx_src.md +++ b/ionic/install_osx_src.md @@ -207,9 +207,9 @@ gz sim -v 4 shapes.sdf -s gz sim -v 4 -g ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Gazebo! ## Troubleshooting -See [Troubleshooting](/docs/ionic/troubleshooting#macos) +See [Troubleshooting](troubleshooting.md#macos) diff --git a/ionic/install_ubuntu.md b/ionic/install_ubuntu.md index 6128fcd95..0eff95f1f 100644 --- a/ionic/install_ubuntu.md +++ b/ionic/install_ubuntu.md @@ -23,7 +23,7 @@ sudo apt-get install gz-ionic All libraries should be ready to use and the `gz sim` app ready to be executed. -Head back to the [Getting started](/docs/all/getstarted) +Head back to the [Getting started](getstarted) page to start using Gazebo! @@ -38,4 +38,4 @@ sudo apt remove gz-ionic && sudo apt autoremove ## Troubleshooting -See [Troubleshooting](/docs/ionic/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) diff --git a/ionic/install_ubuntu_src.md b/ionic/install_ubuntu_src.md index 294a64e41..097a0a725 100644 --- a/ionic/install_ubuntu_src.md +++ b/ionic/install_ubuntu_src.md @@ -173,7 +173,7 @@ colcon build --packages-select PACKAGE_NAME Visit [colcon documentation](https://colcon.readthedocs.io/en/released/#) to view more `colcon` build and test options. -If there are no errors, all the binaries should be ready to use. You can check the [Troubleshooting](/docs/ionic/troubleshooting#ubuntu) section for errors. +If there are no errors, all the binaries should be ready to use. You can check the [Troubleshooting](troubleshooting.md#ubuntu) section for errors. ## Using the workspace @@ -191,7 +191,7 @@ Or in zsh: . ~/workspace/install/setup.zsh ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Gazebo! ## Uninstalling source-based install @@ -216,7 +216,7 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/ionic/troubleshooting#ubuntu) +See [Troubleshooting](troubleshooting.md#ubuntu) ## QML Debugging diff --git a/ionic/install_windows.md b/ionic/install_windows.md index 5457a0aa8..45808f808 100644 --- a/ionic/install_windows.md +++ b/ionic/install_windows.md @@ -69,4 +69,4 @@ conda uninstall libgz- --channel conda-forge ## Troubleshooting -See [Troubleshooting](/docs/ionic/troubleshooting#windows) +See [Troubleshooting](troubleshooting.md#windows) diff --git a/ionic/install_windows_src.md b/ionic/install_windows_src.md index 2bf62c260..5074cbb68 100644 --- a/ionic/install_windows_src.md +++ b/ionic/install_windows_src.md @@ -139,7 +139,7 @@ call install\setup.bat .\install\setup.ps1 ``` -This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) +This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Gazebo! > **NOTE** @@ -198,4 +198,4 @@ the results you want: ## Troubleshooting -See [Troubleshooting](/docs/ionic/troubleshooting#windows) +See [Troubleshooting](troubleshooting.md#windows) diff --git a/ionic/ros2_integration.md b/ionic/ros2_integration.md index b31a9f253..9ae271ed9 100644 --- a/ionic/ros2_integration.md +++ b/ionic/ros2_integration.md @@ -13,7 +13,7 @@ Example uses of the bridge can be found in [`ros_gz_sim_demos`](https://github.c ## Requirements -Please follow the [Install Gazebo and ROS document](/docs/latest/ros_installation) +Please follow the [Install Gazebo and ROS document](ros_installation) before starting this tutorial. A working installation of ROS 2 and Gazebo is required to go further. diff --git a/ionic/ros2_interop.md b/ionic/ros2_interop.md index 197b832c6..077480994 100644 --- a/ionic/ros2_interop.md +++ b/ionic/ros2_interop.md @@ -10,7 +10,7 @@ Users can interact with `rrbot` through ROS 2 commands to move the robot's arms ## Prerequisites -1. A working installation of ROS 2 and Gazebo is required to go further. Please follow the [Install Gazebo and ROS document](/docs/latest/ros_installation). +1. A working installation of ROS 2 and Gazebo is required to go further. Please follow the [Install Gazebo and ROS document](ros_installation). 2. Basic familiarity with ROS concepts and terminal commands. 3. Check out [ROS 2 Integration](ros2_integration) to get familiar with [`ros_gz_bridge`](https://github.com/gazebosim/ros_gz) before starting this tutorial. diff --git a/ionic/tutorials.md b/ionic/tutorials.md index cd1103df2..facda5b02 100644 --- a/ionic/tutorials.md +++ b/ionic/tutorials.md @@ -26,24 +26,24 @@ These tutorials cover general concepts to help get you started with Gazebo. ## Per-library tutorials -See the *API & Tutorials* sections on the [Libraries page](/libs) page for more specific content correlating to each Gazebo library. +See the *API & Tutorials* sections on the [Libraries page](/libs){.external} page for more specific content correlating to each Gazebo library. The entrypoint library is Sim. -- [Sim](/api/sim/8/tutorials.html) +- [Sim](/api/sim/8/tutorials.html){.external} Other libraries: -- [Cmake](/api/cmake/3/tutorials.html) -- [Common](/api/common/5/tutorials.html) -- [Fuel_tools](/api/fuel_tools/9/tutorials.html) -- [Gui](/api/gui/8/tutorials.html) -- [Launch](/api/launch/7/tutorials.html) -- [Math](/api/math/7/tutorials.html) -- [Msgs](/api/msgs/10/tutorials.html) -- [Physics](/api/physics/7/tutorials.html) -- [Plugin](/api/plugin/2/tutorials.html) -- [Rendering](/api/rendering/8/tutorials.html) -- [Sensors](/api/sensors/8/tutorials.html) -- [Tools](/api/tools/2/tutorials.html) -- [Transport](/api/transport/13/tutorials.html) -- [Utils](/api/utils/2/tutorials.html) -- [Sdformat](/api/sdformat/13/) +- [Cmake](/api/cmake/3/tutorials.html){.external} +- [Common](/api/common/5/tutorials.html){.external} +- [Fuel_tools](/api/fuel_tools/9/tutorials.html){.external} +- [Gui](/api/gui/8/tutorials.html){.external} +- [Launch](/api/launch/7/tutorials.html){.external} +- [Math](/api/math/7/tutorials.html){.external} +- [Msgs](/api/msgs/10/tutorials.html){.external} +- [Physics](/api/physics/7/tutorials.html){.external} +- [Plugin](/api/plugin/2/tutorials.html){.external} +- [Rendering](/api/rendering/8/tutorials.html){.external} +- [Sensors](/api/sensors/8/tutorials.html){.external} +- [Tools](/api/tools/2/tutorials.html){.external} +- [Transport](/api/transport/13/tutorials.html){.external} +- [Utils](/api/utils/2/tutorials.html){.external} +- [Sdformat](/api/sdformat/13/){.external} diff --git a/migrating_gazebo_classic_ros2_packages.md b/migrating_gazebo_classic_ros2_packages.md index 283528c57..ae02373e5 100644 --- a/migrating_gazebo_classic_ros2_packages.md +++ b/migrating_gazebo_classic_ros2_packages.md @@ -132,7 +132,7 @@ This tutorial assumes you are using Gazebo Fortress as it is the version of Gazebo officially paired with ROS 2 Humble. While it is possible to use newer versions of Gazebo with ROS 2 Humble, it requires extra work and is not recommend for most users. See -[Installing Gazebo with ROS](https://gazebosim.org/docs/latest/ros_installation) +[Installing Gazebo with ROS](ros_installation) to learn more. If you intend to switch back and forth between the new Gazebo and Gazebo Classic, it's best to use Gazebo Fortress since the newer versions will automatically uninstall Gazebo Classic. With that being said, the concepts @@ -715,9 +715,9 @@ other aspects, such as migrating Gazebo Classic plugins, materials and textures. - Case study: migrating the ArduPilot ModelPlugin from Gazebo classic to Gazebo - [Fortress](https://gazebosim.org/api/gazebo/6/ardupilot.html) | [Harmonic](https://gazebosim.org/api/sim/8/ardupilot.html) -- [Basic description of SDF worlds](https://gazebosim.org/docs/latest/sdf_worlds) -- [Feature Comparison with Gazebo Classic](https://gazebosim.org/docs/latest/comparison) -- [Documentation for ros_gz](https://gazebosim.org/docs/latest/ros2_integration) +- [Basic description of SDF worlds](sdf_worlds) +- [Feature Comparison with Gazebo Classic](comparison) +- [Documentation for ros_gz](ros2_integration) - List of Systems (plugins): [Fortress](https://gazebosim.org/api/gazebo/6/namespaceignition_1_1gazebo_1_1systems.html) | diff --git a/release_features.md b/release_features.md index 9852f661d..c0c087438 100644 --- a/release_features.md +++ b/release_features.md @@ -2,7 +2,7 @@ Here you will find the set of features that are available in each release. -Take a look at the [Roadmap](/docs/all/roadmap) for information about upcoming +Take a look at the [Roadmap](roadmap) for information about upcoming features, some of which may land in released versions of Gazebo. ## Harmonic @@ -353,11 +353,11 @@ For a complete list of features included in the initial release of Harmonic, ple The first major release of Gazebo focused on the basics of simulation. The basics primarily encompassed integration of physics, sensors, graphical tools, and programmatic interfaces. -1. Support for [DART](https://dartsim.github.io/) in [Gazebo Physics](/libs/physics). -2. Ogre1.9 and Ogre2.1 support in [Gazebo Rendering](/libs/rendering) -3. [Entity Component System](https://en.wikipedia.org/wiki/Entity_component_system) based simulation engine in [Gazebo Sim](/libs/gazebo). -4. A sensor suite that includes contact sensor, logical camera, monocular camera, depth camera, LIDAR, magnetometer, altimeter, and IMU is available through [Gazebo Sensors](/libs/sensors) and [Gazebo Sim](/libs/gazebo). -5. [Launch system](/libs/launch) capable of running and managing a set of plugins and executables. +1. Support for [DART](https://dartsim.github.io/) in [Gazebo Physics](/libs/physics){.external}. +2. Ogre1.9 and Ogre2.1 support in [Gazebo Rendering](/libs/rendering){.external} +3. [Entity Component System](https://en.wikipedia.org/wiki/Entity_component_system) based simulation engine in [Gazebo Sim](/libs/gazebo){.external}. +4. A sensor suite that includes contact sensor, logical camera, monocular camera, depth camera, LIDAR, magnetometer, altimeter, and IMU is available through [Gazebo Sensors](/libs/sensors){.external} and [Gazebo Sim](/libs/gazebo){.external}. +5. [Launch system](/libs/launch){.external} capable of running and managing a set of plugins and executables. 6. Cloud-hosted simulation assets provided by [app.gazebosim.org](https://app.gazebosim.org). 7. Distributed simulation using lock-stepping. 8. Dynamic loading/unloading of simulation models based on the location of performer, usually a robot. diff --git a/release_instructions.md b/release_instructions.md index 927d75624..ca8677870 100644 --- a/release_instructions.md +++ b/release_instructions.md @@ -58,12 +58,12 @@ the process: ### 2. Update code version and changelogs The first step to get a new release ready is to update the current code (upstream) -version (view the [versioning](release#versioning) section for more information). This +version (view the [versioning](release.md#versioning) section for more information). This bump could be in the major number (non-compatible changes), minor number (new features), patch number (patches and bugfixes). **Bumping major number** of the version implies some work to have the -[metadata](#metadata-for-releasing) updated correctly. There is a [dedicated +metadata updated correctly. There is a [dedicated document](releasing/bump_major.md) that you should go through before continuing to work through the steps in this document. @@ -158,7 +158,7 @@ build in the server. Now, the following needs to happen: 1. Brew: entry job is `generic-release-homebrew_pull_request_updater` The `release.py` script and Jenkins will perform all these actions. For more information of all the processes -triggered by the `release.py` script please check [the release process](release#using-the-gzdev-repository-command). +triggered by the `release.py` script please check [the release process](release.md#using-the-gzdev-repository-command). ### 4. Executing release.py @@ -170,7 +170,7 @@ Running `release.py` from the source code repository will generate and upload some Git tags ("release tags") to the source code repository. You will also need the token described in the [credentials -section](#access-and-credentials). +section](#2-access-and-credentials). **dry-run simulation mode** @@ -236,7 +236,7 @@ ordering for package managers. [This information about versioning](https://class **release.py for revision bumps** -Bumping the [revision number for binary packages](release#versioning) is a special +Bumping the [revision number for binary packages](release.md#versioning) is a special case of releasing since the original tarball with the source code will remain the same. Once the release repository is ready with the new release version, `release.py` needs the `--only-bump-revision-linux` flag. diff --git a/releases.md b/releases.md index 45afb90c2..6a5ff2b10 100644 --- a/releases.md +++ b/releases.md @@ -4,7 +4,7 @@ This page details the set of past and planned releases. ## What is a Release? -A release of Gazebo consists of a set of versioned [Gazebo Libraries](/libs). Each library follows [semantic versioning](https://semver.org), and the major version of a library is guaranteed not to change with an Gazebo release. This essentially means you can develop code against a release of Gazebo without the worry of breaking changes being made upstream. +A release of Gazebo consists of a set of versioned [Gazebo Libraries](/libs){.external}. Each library follows [semantic versioning](https://semver.org){.external}, and the major version of a library is guaranteed not to change with an Gazebo release. This essentially means you can develop code against a release of Gazebo without the worry of breaking changes being made upstream. ### Naming Scheme diff --git a/roadmap.md b/roadmap.md index 13e1e8b9d..9b790792b 100644 --- a/roadmap.md +++ b/roadmap.md @@ -50,12 +50,12 @@ info@openrobotics.org. A number of features are planned for specific releases of Gazebo. The features listed here derive from the Quarterly Roadmap, listed above, and other -ongoing projects. See the [Release Features](/docs/all/release-features) page +ongoing projects. See the [Release Features](release-features) page for a list of features already available in each release of Gazebo. A named release of Gazebo, such as Acropolis or Blueprint, is tied to -a set of [library](/libs) major versions. Our -[development and release pattern](/docs/all/releases) allows us to distribute +a set of [library](/libs){.external} major versions. Our +[development and release pattern](releases) allows us to distribute patch and minor updates into a stable Gazebo version. For example, if a new feature does not break API/ABI then we will target the feature to the oldest compatible non-EOL release and propagate the feature forward. @@ -82,7 +82,7 @@ compatible non-EOL release and propagate the feature forward. ### Ionic -See the [Quarterly Roadmap](/docs/all/roadmap#quarterly-roadmap) above. +See the [Quarterly Roadmap](#quarterly-roadmap) above. ## Planned releases @@ -94,8 +94,8 @@ Please see the [Releases](https://github.com/gazebosim/docs/blob/master/releases Looking for something to work on, or just want to help out? Here are a few resources to get you going. -1. [How to contribute](/docs/all/contributing) guide. -1. [Feature comparision](/docs/citadel/comparison) list. This page lists the +1. [How to contribute](contributing) guide. +1. [Feature comparision](/docs/citadel/comparison){.external} list. This page lists the feature gaps between Gazebo classic and Gazebo Sim. -1. Take a look at the various [libraries](/libs), and the issue tracker +1. Take a look at the various [libraries](/libs){.external}, and the issue tracker associated with each. diff --git a/ros2_gz_vendor_pkgs.md b/ros2_gz_vendor_pkgs.md index d408d01a8..45ba7ecdd 100644 --- a/ros2_gz_vendor_pkgs.md +++ b/ros2_gz_vendor_pkgs.md @@ -7,10 +7,10 @@ upstream Ubuntu. However, due to the package [update policy of Ubuntu](https://wiki.ubuntu.com/StableReleaseUpdates), the Gazebo packages on upstream Ubuntu did not receive any updates. Thus, upstream Ubuntu almost always had older versions of Gazebo than what was available from -the Gazebo package repository ([packages.osrfoundation.org](packages.osrfoundation.org)). To overcome this, +the Gazebo package repository ([packages.osrfoundation.org](https://packages.osrfoundation.org)). To overcome this, more up-to-date Gazebo packages were copied to the ROS bootstrap repository -([repos.ros.org](repos.ros.org)) which were then copied to the main ROS package repository -([packages.ros.org](packages.ros.org)). However, the process was error prone and keeping package +([repos.ros.org](https://repos.ros.org)) which were then copied to the main ROS package repository +([packages.ros.org](https://packages.ros.org)). However, the process was error prone and keeping package versions in sync between the Gazebo and ROS package repositories was difficult since this was a manual process. @@ -31,7 +31,7 @@ Each release of ROS 2 is paired with a specific release of Gazebo. For ROS 2 Jazzy, the vendor packages contain Gazebo libraries from the Harmonic release. For ROS 2 K-turtle (next release), the vendor packages will contain Gazebo Ionic. This default pairing is found in the -[ROS installation instructions](https://gazebosim.org/docs/harmonic/ros_installation) +[ROS installation instructions](ros_installation) The following is a table of all vendor packages and the underlying Gazebo library they vendor: @@ -140,7 +140,7 @@ If you want to use a new release of Gazebo that is not officially paired with the release of ROS you are using (e.g. Gazebo Ionic with ROS 2 Jazzy), you can follow the following steps: -1. Install the binaries from [packages.osrfoundation.org](packages.osrfoundation.org). Make sure to install +1. Install the binaries from [packages.osrfoundation.org](https://packages.osrfoundation.org). Make sure to install the metapackage that includes all library components (e.g. gz-ionic, gz-harmonic, etc.) 1. Clone the set of vendor packages included in @@ -148,7 +148,7 @@ follow the following steps: in your workspace using [vcstool](https://github.com/dirk-thomas/vcstool). 1. Checkout the desired branch. The branch names currently track ROS 2 releases. You'll need to determine the branch based on the - [default pairings](/docs/latest/ros_installation) + [default pairings](ros_installation) 1. Add any additional packages you need that also depend on Gazebo, such as [`ros_gz`](https://github.com/gazebosim/ros_gz) and [`gz_ros2_control`](https://github.com/ros-controls/gz_ros2_control/) @@ -178,7 +178,7 @@ source: [vcstool](https://github.com/dirk-thomas/vcstool). 1. Checkout the desired branch. The branch names currently track ROS 2 releases. You'll need to determine the branch based on the - [official pairings](/docs/latest/ros_installation) + [official pairings](ros_installation) 1. Add any additional packages you need that also depend on Gazebo, such as [`ros_gz`](https://github.com/gazebosim/ros_gz) and [`gz_ros2_control`](https://github.com/ros-controls/gz_ros2_control/) diff --git a/ros_installation.md b/ros_installation.md index 8138a542c..ab7751485 100644 --- a/ros_installation.md +++ b/ros_installation.md @@ -253,7 +253,7 @@ repository. The ROS repository syncs from the `osrfoundation.org` repository frequently but versions can be different. Getting the latest versions of the Gazebo libraries and simulator is as easy -as installing the [`osrfoundation.org` repository](https://gazebosim.org/docs/latest/install_ubuntu_src#install-dependencies) +as installing the [`osrfoundation.org` repository](install_ubuntu_src.md#install-dependencies) together with the ROS repository. Updates should be fully compatible. ### FAQ @@ -280,7 +280,7 @@ other ROS packages that depend on Gazebo-classic. #### Where I can find the different features implemented on each Gazebo version? The best place is the Gazebo web page that hosts a list of the -[main features available in each Gazebo distribution](https://gazebosim.org/docs/latest/release-features). +[main features available in each Gazebo distribution](release-features). Some notes are regularly posted on the [Gazebo community site](https://community.gazebosim.org/tags/c/release-announcements-and-discussions/10/release) @@ -292,5 +292,5 @@ one for examples. Additionally, when navigating through the different versions of Gazebo there is a menu item -called "[Feature Comparison](https://gazebosim.org/docs/garden/comparison)" which provides a comparison with the features of Gazebo-Classic. +called "[Feature Comparison](comparison)" which provides a comparison with the features of Gazebo-Classic. In the top right corner of the [Gazebo documentation page](https://gazebosim.org/docs) the specific Gazebo version to compare with can be selected. diff --git a/tools/branch_comparisons.md b/tools/branch_comparisons.md index 18d13f825..6448de473 100644 --- a/tools/branch_comparisons.md +++ b/tools/branch_comparisons.md @@ -11,7 +11,7 @@ no pull requests need to be forward-ported. Otherwise, those branches could use a forward-port pull request. See the instructions on the -[contributing guide](https://gazebosim.org/docs/all/contributing#process). +[contributing guide](contributing.md#process). * **C**: Citadel * **E**: Edifice diff --git a/tools/versions.md b/tools/versions.md index 88949ae23..10db74e1b 100644 --- a/tools/versions.md +++ b/tools/versions.md @@ -17,7 +17,7 @@ How to read the columns: * **Gazebo Classic**: What Gazebo classic version requires as depedency that specific version (i.e. 9 for Gazebo 9). * **Gazebo**: What Gazebo version uses that specific version (i.e. B for Blueprint). * **Release date**: Release date for that specific version. TBD, to be decided, means that there aren't any current plans to release that version. -* **EOL date**: Date of end of support. In general, each library's version is released as part of an [Gazebo release](https://gazebosim.org/docs/all/releases) and EOLs either with that Gazebo release, or with a later one. Libraries that are planned to be supported in the upcoming Gazebo release have a TBD EOL date because they may also be included in future releases. All EOL dates may be moved to a later date, but never to an earlier date. +* **EOL date**: Date of end of support. In general, each library's version is released as part of an [Gazebo release](releases) and EOLs either with that Gazebo release, or with a later one. Libraries that are planned to be supported in the upcoming Gazebo release have a TBD EOL date because they may also be included in future releases. All EOL dates may be moved to a later date, but never to an earlier date. |Package|Version|Status|Ubuntu packages|OSRF packages|ROS packages|Gazebo Classic|Gazebo|Release date|EOL date| |---|---|---|---|---|---|---|---|---|---|