From 084fd2d35515280d5a399e90153c72bfd2ef69c3 Mon Sep 17 00:00:00 2001 From: Jose Luis Rivero Date: Wed, 15 Feb 2023 17:55:45 +0100 Subject: [PATCH 1/7] Change get_started to recommened Gz version per platform for installations Signed-off-by: Jose Luis Rivero --- get_started.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/get_started.md b/get_started.md index 69ea1785..d881becd 100644 --- a/get_started.md +++ b/get_started.md @@ -7,10 +7,28 @@ simulation using Gazebo. ## Step 1: Install -Each release of Gazebo ships with a new installation tutorial. You can -read [the latest installation tutorial here](/docs/latest/install). Please -visit the [main documentation](/docs) pages for a list of all releases, -along with links to their respective installation tutorials. +The recommended installation for non expert users is the use of binary +packages available for the platform to use when possible. + +|Platform|Gz Versions| +|---|---| +| Ubuntu 22.04 Jammy | [Gz Garden (recommended)](docs/garden/install_ubuntu), [Gz Fortress](docs/fortress/install_ubuntu) +| Ubuntu 20.04 Focal | [Gz Garden (recommended)](docs/garden/install_buuntu), [Gz Fortress](docs/fortress/install_ubuntu), [Gz Citadel](docs/citadel/install_ubuntu) +| Ubuntu 18.04 Bionic | [Gz Citadel](docs/citadel/install_ubuntu) +| Mac Monterey | [Gz Garden (recommended)](docs/garden/install_osx), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) +| Mac BigSur | [Gz Garden (recommended)](docs/garden/install_osx), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) +| Mac Catalina | [Gz Garden (recommended)](docs/garden/install_osx), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) + +Windows support via conda-forge is not fully functional, there are known runtime problems +[stoping Gz to work](https://github.com/gazebosim/gz-sim/issues/168). + +If the desired plaform is not listed above or if a particular feature in a +given Gz release is needed, there is a installation package per release +available with all the installation options: + +* [Gz Garden](docs/garden/install) installation options +* [Gz Fortress](docs/fortress/install) installation options +* [Gz Citadel](docs/citadel/install) installation options ## Step 2: Run From d7541ba3097eea9a94afab90500d7bce3293c368 Mon Sep 17 00:00:00 2001 From: Jose Luis Rivero Date: Wed, 15 Feb 2023 17:55:45 +0100 Subject: [PATCH 2/7] Change get_started to recommened Gz version per platform for installations Signed-off-by: Jose Luis Rivero --- get_started.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/get_started.md b/get_started.md index d881becd..7b267588 100644 --- a/get_started.md +++ b/get_started.md @@ -12,12 +12,12 @@ packages available for the platform to use when possible. |Platform|Gz Versions| |---|---| -| Ubuntu 22.04 Jammy | [Gz Garden (recommended)](docs/garden/install_ubuntu), [Gz Fortress](docs/fortress/install_ubuntu) -| Ubuntu 20.04 Focal | [Gz Garden (recommended)](docs/garden/install_buuntu), [Gz Fortress](docs/fortress/install_ubuntu), [Gz Citadel](docs/citadel/install_ubuntu) +| Ubuntu 22.04 Jammy | [Gz Garden](docs/garden/install_ubuntu) (recommended) and [Gz Fortress](docs/fortress/install_ubuntu) +| Ubuntu 20.04 Focal | [Gz Garden](docs/garden/install_buuntu) (recommended), [Gz Fortress](docs/fortress/install_ubuntu) and [Gz Citadel](docs/citadel/install_ubuntu) | Ubuntu 18.04 Bionic | [Gz Citadel](docs/citadel/install_ubuntu) -| Mac Monterey | [Gz Garden (recommended)](docs/garden/install_osx), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) -| Mac BigSur | [Gz Garden (recommended)](docs/garden/install_osx), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) -| Mac Catalina | [Gz Garden (recommended)](docs/garden/install_osx), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) +| Mac Monterey | [Gz Garden](docs/garden/install_osx) (recommended), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) +| Mac BigSur | [Gz Garden](docs/garden/install_osx) (recommended), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) +| Mac Catalina | [Gz Garden](docs/garden/install_osx) (recommended), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) Windows support via conda-forge is not fully functional, there are known runtime problems [stoping Gz to work](https://github.com/gazebosim/gz-sim/issues/168). From 6000cb92a0b89f613bf53aa3b0342950b9882d1e Mon Sep 17 00:00:00 2001 From: Jose Luis Rivero Date: Wed, 15 Feb 2023 18:14:59 +0100 Subject: [PATCH 3/7] Simplify sentence --- get_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get_started.md b/get_started.md index 7b267588..f9f27aae 100644 --- a/get_started.md +++ b/get_started.md @@ -8,7 +8,7 @@ simulation using Gazebo. ## Step 1: Install The recommended installation for non expert users is the use of binary -packages available for the platform to use when possible. +packages available for the platform to use: |Platform|Gz Versions| |---|---| From 53010dc2c8a1cad89e1304822fb2727a9f16305d Mon Sep 17 00:00:00 2001 From: Jose Luis Rivero Date: Wed, 15 Feb 2023 20:33:30 +0100 Subject: [PATCH 4/7] Fixes thanks to Mabel Co-authored-by: Mabel Zhang --- get_started.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/get_started.md b/get_started.md index f9f27aae..ae68696c 100644 --- a/get_started.md +++ b/get_started.md @@ -13,17 +13,17 @@ packages available for the platform to use: |Platform|Gz Versions| |---|---| | Ubuntu 22.04 Jammy | [Gz Garden](docs/garden/install_ubuntu) (recommended) and [Gz Fortress](docs/fortress/install_ubuntu) -| Ubuntu 20.04 Focal | [Gz Garden](docs/garden/install_buuntu) (recommended), [Gz Fortress](docs/fortress/install_ubuntu) and [Gz Citadel](docs/citadel/install_ubuntu) +| Ubuntu 20.04 Focal | [Gz Garden](docs/garden/install_ubuntu) (recommended), [Gz Fortress](docs/fortress/install_ubuntu) and [Gz Citadel](docs/citadel/install_ubuntu) | Ubuntu 18.04 Bionic | [Gz Citadel](docs/citadel/install_ubuntu) | Mac Monterey | [Gz Garden](docs/garden/install_osx) (recommended), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) | Mac BigSur | [Gz Garden](docs/garden/install_osx) (recommended), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) | Mac Catalina | [Gz Garden](docs/garden/install_osx) (recommended), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) Windows support via conda-forge is not fully functional, there are known runtime problems -[stoping Gz to work](https://github.com/gazebosim/gz-sim/issues/168). +[stopping Gz to work](https://github.com/gazebosim/gz-sim/issues/168). -If the desired plaform is not listed above or if a particular feature in a -given Gz release is needed, there is a installation package per release +If the desired platform is not listed above or if a particular feature in a +given Gz release is needed, there is an installation package per release available with all the installation options: * [Gz Garden](docs/garden/install) installation options From 22eae30e02554e972c34ba0a3da83b56d7503646 Mon Sep 17 00:00:00 2001 From: Jose Luis Rivero Date: Thu, 16 Feb 2023 00:13:02 +0100 Subject: [PATCH 5/7] Apply suggestions from Kat Co-authored-by: Katherine Scott --- get_started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/get_started.md b/get_started.md index ae68696c..276df59a 100644 --- a/get_started.md +++ b/get_started.md @@ -7,7 +7,7 @@ simulation using Gazebo. ## Step 1: Install -The recommended installation for non expert users is the use of binary +The recommended installation for new users is the use of binary packages available for the platform to use: |Platform|Gz Versions| @@ -20,7 +20,7 @@ packages available for the platform to use: | Mac Catalina | [Gz Garden](docs/garden/install_osx) (recommended), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) Windows support via conda-forge is not fully functional, there are known runtime problems -[stopping Gz to work](https://github.com/gazebosim/gz-sim/issues/168). +[Gz for Windows Issue](https://github.com/gazebosim/gz-sim/issues/168). If the desired platform is not listed above or if a particular feature in a given Gz release is needed, there is an installation package per release From 851eac8969b6d386263f976e2abfe5c5e58a1641 Mon Sep 17 00:00:00 2001 From: Jose Luis Rivero Date: Mon, 20 Feb 2023 17:07:49 +0100 Subject: [PATCH 6/7] Replace Gz by Gazebo Signed-off-by: Jose Luis Rivero --- get_started.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/get_started.md b/get_started.md index 276df59a..9c8e8c83 100644 --- a/get_started.md +++ b/get_started.md @@ -10,25 +10,25 @@ simulation using Gazebo. The recommended installation for new users is the use of binary packages available for the platform to use: -|Platform|Gz Versions| +|Platform|Gazebo Versions| |---|---| -| Ubuntu 22.04 Jammy | [Gz Garden](docs/garden/install_ubuntu) (recommended) and [Gz Fortress](docs/fortress/install_ubuntu) -| Ubuntu 20.04 Focal | [Gz Garden](docs/garden/install_ubuntu) (recommended), [Gz Fortress](docs/fortress/install_ubuntu) and [Gz Citadel](docs/citadel/install_ubuntu) -| Ubuntu 18.04 Bionic | [Gz Citadel](docs/citadel/install_ubuntu) -| Mac Monterey | [Gz Garden](docs/garden/install_osx) (recommended), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) -| Mac BigSur | [Gz Garden](docs/garden/install_osx) (recommended), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) -| Mac Catalina | [Gz Garden](docs/garden/install_osx) (recommended), [Gz Fortress](docs/fortress/install_osx) and [Gz Citadel](docs/citadel/install_osx) +| Ubuntu 22.04 Jammy | [Gazebo Garden](docs/garden/install_ubuntu) (recommended) and [Gazebo Fortress](docs/fortress/install_ubuntu) +| Ubuntu 20.04 Focal | [Gazebo Garden](docs/garden/install_ubuntu) (recommended), [Gazebo Fortress](docs/fortress/install_ubuntu) and [Gazebo Citadel](docs/citadel/install_ubuntu) +| Ubuntu 18.04 Bionic | [Gazebo Citadel](docs/citadel/install_ubuntu) +| Mac Monterey | [Gazebo Garden](docs/garden/install_osx) (recommended), [Gazebo Fortress](docs/fortress/install_osx) and [Gazebo Citadel](docs/citadel/install_osx) +| Mac BigSur | [Gazebo Garden](docs/garden/install_osx) (recommended), [Gazebo Fortress](docs/fortress/install_osx) and [Gazebo Citadel](docs/citadel/install_osx) +| Mac Catalina | [Gazebo Garden](docs/garden/install_osx) (recommended), [Gazebo Fortress](docs/fortress/install_osx) and [Gazebo Citadel](docs/citadel/install_osx) Windows support via conda-forge is not fully functional, there are known runtime problems -[Gz for Windows Issue](https://github.com/gazebosim/gz-sim/issues/168). +[Gazebo for Windows Issue](https://github.com/gazebosim/gz-sim/issues/168). If the desired platform is not listed above or if a particular feature in a -given Gz release is needed, there is an installation package per release +given Gazebo release is needed, there is an installation package per release available with all the installation options: -* [Gz Garden](docs/garden/install) installation options -* [Gz Fortress](docs/fortress/install) installation options -* [Gz Citadel](docs/citadel/install) installation options +* [Gazebo Garden](docs/garden/install) installation options +* [Gazebo Fortress](docs/fortress/install) installation options +* [Gazebo Citadel](docs/citadel/install) installation options ## Step 2: Run From 0e2492a411ea92afe8f3ddcb307701033475a29c Mon Sep 17 00:00:00 2001 From: Jose Luis Rivero Date: Mon, 20 Feb 2023 17:13:29 +0100 Subject: [PATCH 7/7] Include EOL information in releases Signed-off-by: Jose Luis Rivero --- get_started.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/get_started.md b/get_started.md index 9c8e8c83..db8defdd 100644 --- a/get_started.md +++ b/get_started.md @@ -23,12 +23,13 @@ Windows support via conda-forge is not fully functional, there are known runtime [Gazebo for Windows Issue](https://github.com/gazebosim/gz-sim/issues/168). If the desired platform is not listed above or if a particular feature in a -given Gazebo release is needed, there is an installation package per release -available with all the installation options: +given [Gazebo release](https://gazebosim.org/docs/latest/releases) is needed, +there is an installation package per release available with all the +installation options: -* [Gazebo Garden](docs/garden/install) installation options -* [Gazebo Fortress](docs/fortress/install) installation options -* [Gazebo Citadel](docs/citadel/install) installation options +* [Gazebo Garden installation](docs/garden/install) options (EOL 2024 Sep) +* [Gazebo Fortress (LTS) installation](docs/fortress/install) options (EOL 2026 Sep) +* [Gazebo Citadel (LTS) installation](docs/citadel/install) options (EOL 2024 Dec) ## Step 2: Run