From 03bb7654c3b51342da6971fac30c91196c74a368 Mon Sep 17 00:00:00 2001 From: methylDragon Date: Wed, 20 Jul 2022 15:55:23 -0700 Subject: [PATCH] Migrate migration guide Co-authored-by: Louise Poubel Signed-off-by: methylDragon Yes, I'm being tongue-in-cheek --- garden/install.md | 5 +++-- garden/{migration.md => migration_from_ignition.md} | 8 ++++---- 2 files changed, 7 insertions(+), 6 deletions(-) rename garden/{migration.md => migration_from_ignition.md} (98%) diff --git a/garden/install.md b/garden/install.md index 975f5c56b..490b5f492 100644 --- a/garden/install.md +++ b/garden/install.md @@ -60,7 +60,8 @@ for the full status. ## Migration Guide -Gazebo Garden is the first major release that [uses the Gazebo brand instead of Ignition](https://community.gazebosim.org/t/a-new-era-for-gazebo/1356). So if you are upgrading from a prior release (e.g. Fortress), you will need to do some steps to migrate your packages. +Gazebo Garden is the first major release that [uses the Gazebo brand instead of Ignition](https://community.gazebosim.org/t/a-new-era-for-gazebo/1356). +So if you are upgrading from a prior release (e.g. Fortress), you will need to do some steps to migrate your packages. -- [Migration Guide](migration) +- [Guide for Migrating From Ignition](migration_from_ignition) diff --git a/garden/migration.md b/garden/migration_from_ignition.md similarity index 98% rename from garden/migration.md rename to garden/migration_from_ignition.md index 6fb3bb013..85f6ff187 100644 --- a/garden/migration.md +++ b/garden/migration_from_ignition.md @@ -30,7 +30,7 @@ You may also look at the [tracking GitHub issue](https://github.com/gazebo-tooli This section provides just an overview of the different changes made, for a more detailed listing of tick-tocks, see the `[MIGRATION.md](http://MIGRATION.md)` file in each of the individual core libraries’ repositories. Additionally the migration pointers in a later section of this migration guide should help you get your packages ready and working with Gazebo. -Generally speaking, you should still be able to use either the Ignition counterpart or Gazebo counterpart for **most things** if you are using Garden, due to explicit tick-tocking logic written in the stack. Just note that using the Ignition counterpart will generally cause deprecation warnings to emit. +Generally speaking, you should still be able to use either the Ignition counterpart or Gazebo counterpart for **most things** if you are using Garden, due to explicit tick-tocking logic written in the stack. Just note that using the Ignition counterpart will generally cause deprecation warnings to be emitted. ### Tick-tocks @@ -93,7 +93,7 @@ Also, in the source code, most of these tick-tocks will have an associated comme - GitHub actions and workflows - e.g. `ignition-tooling` → `gazebo-tooling` - Websites - - e.g. `[ignitionrobotics.org](http://ignitionrobotics.org)` → `gazebosim.org` + - e.g. [ignitionrobotics.org](http://ignitionrobotics.org) → [gazebosim.org](http://gazebosim.org) - SDF and launch tags - e.g. `` → `` @@ -160,7 +160,7 @@ Also, anything that is internal to the core Gazebo libraries and not used in dow A very small selection of things have not been migrated, mostly for backwards compatibility reasons (e.g. supporting Fortress.) - Branch names for versions of Gazebo libraries targeting releases before Garden - - e.g. `ign-cmake1` + - e.g. `ign-cmake2` - Some links - e.g. [https://osrf-migration.github.io/ignition-gh-pages](https://osrf-migration.github.io/ignition-gh-pages) - Fuel user agent related @@ -170,7 +170,7 @@ A very small selection of things have not been migrated, mostly for backwards co ## Overview -The following migration guidelines are just that—guidelines and suggestions for how to get your package migrated, that hopefully should cover most general cases. +The following migration guidelines are just that—guidelines and suggestions for how to get your package migrated, that should cover most general cases. Just keep in mind the overarching goal of replacing every Ignition counterpart (`IGN`, `Ign`, `Ignition`, `ign`, `ignition`) to the Gazebo counterpart (`GZ`, `Gz`, `gz`).