diff --git a/citadel/install.md b/citadel/install.md index 5f00fc1d7..d23698b28 100644 --- a/citadel/install.md +++ b/citadel/install.md @@ -1,18 +1,6 @@ -# Citadel Installation - -Citadel supports the following platforms: - - * Ubuntu Bionic on amd64/i386 and Focal on amd64 - * MacOS Mojave - * Ignition currently only works in headless mode - (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use - `ign gazebo -s fuel.sdf` to start the server only). - * Windows 10 - * Ignition command line utilities are not yet supported. - * All packages up to but not including `ign-gazebo` are currently building. - * DART physics engine is not yet supported. - * Qt (GUI functionality) is not yet supported. +# Ignition Citadel +Ignition Citadel is the 3rd major release of Ignition, and its 1st 5-year-LTS. ## Binary installation instructions @@ -52,3 +40,18 @@ collection assures that all libraries are compatible and can be used together. | ign-tools | 1.x | | ign-transport | 8.x | | sdformat | 9.x | + +## Supported platforms + +Citadel is [supported](/docs/all/releases) on the platforms below. + +These are the **officially** supported platforms: + +* Ubuntu Bionic on amd64/i386 +* Ubuntu Focal on amd64 + +Platforms supported at **best-effort** include arm architectures, Windows and +macOS. See +[this ticket](https://github.com/ignition-tooling/release-tools/issues/595) +for the full status. + diff --git a/dome/install.md b/dome/install.md index 0177c520f..e0724a9fb 100644 --- a/dome/install.md +++ b/dome/install.md @@ -1,18 +1,6 @@ -# Dome Installation - -Dome supports the following platforms: - - * Ubuntu Bionic amd64/arm64/i386 and Focal on amd64/arm64 - * MacOS Mojave and Catalina - * Ignition currently only works in headless mode - (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use - `ign gazebo -s fuel.sdf` to start the server only). - * Windows 10 - * Ignition command line utilities are not yet supported. - * All packages up to but not including `ign-gazebo` are currently building. - * DART physics engine is not yet supported. - * Qt (GUI functionality) is not yet supported. +# Ignition Dome +Ignition Dome is the 4th major release of Ignition. It's a short-term support. ## Binary installation instructions @@ -52,3 +40,17 @@ collection assures that all libraries are compatible and can be used together. | ign-tools | 1.x | | ign-transport | 9.x | | sdformat | 10.x | + +## Supported platforms + +Dome is [supported](/docs/all/releases) on the platforms below. + +These are the **officially** supported platforms: + +* Ubuntu Bionic on amd64/i386 +* Ubuntu Focal on amd64 + +Platforms supported at **best-effort** include arm architectures, Windows and +macOS. See +[this ticket](https://github.com/ignition-tooling/release-tools/issues/297) +for the full status. diff --git a/edifice/install.md b/edifice/install.md index eacf1c648..6e1111de2 100644 --- a/edifice/install.md +++ b/edifice/install.md @@ -1,18 +1,6 @@ -# Edifice Installation - -Edifice supports the following platforms: - - * Ubuntu Bionic amd64/arm64/i386 and Focal on amd64/arm64 - * MacOS Mojave and Catalina - * Ignition currently only works in headless mode - (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use - `ign gazebo -s fuel.sdf` to start the server only). - * Windows 10 - * Ignition command line utilities are not yet supported. - * All packages up to but not including `ign-gazebo` are currently building. - * DART physics engine is not yet supported. - * Qt (GUI functionality) is not yet supported. +# Ignition Edifice +Ignition Edifice is the 5th major release of Ignition. It's a short-term support. ## Binary installation instructions @@ -53,3 +41,17 @@ collection assures that all libraries are compatible and can be used together. | ign-transport | 10.x | | ign-utils | 1.x | | sdformat | 11.x | + +## Supported platforms + +Edifice is [supported](/docs/all/releases) on the platforms below. + +These are the **officially** supported platforms: + +* Ubuntu Bionic on amd64/i386 +* Ubuntu Focal on amd64 + +Platforms supported at **best-effort** include arm architectures, Windows and +macOS. See +[this ticket](https://github.com/ignition-tooling/release-tools/issues/421) +for the full status. diff --git a/fortress/install.md b/fortress/install.md index 8ffa12b6c..f966cfdfa 100644 --- a/fortress/install.md +++ b/fortress/install.md @@ -1,17 +1,6 @@ -# Fortress Installation +# Ignition Fortress -Fortress supports the following platforms: - - * Ubuntu Bionic amd64/arm64/i386 and Focal on amd64/arm64 - * MacOS Catalina and BigSur - * Ignition currently only works in headless mode using Ogre 1 - (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use - `ign gazebo -s fuel.sdf` to start the server only). - * Windows 10 - * Ignition command line utilities are not yet supported. - * All packages up to `ign-gazebo` can be built. - * DART physics engine is not yet supported. - * Qt (GUI functionality) is not yet supported. +Ignition Fortress is the 6th major release of Ignition, and its 2nd 5-year LTS. ## Binary installation instructions @@ -59,3 +48,18 @@ collection assures that all libraries are compatible and can be used together. | ign-transport | 11.x | | ign-utils | 1.x | | sdformat | 12.x | + +## Supported platforms + +Fortress is [supported](/docs/all/releases) on the platforms below. + +These are the **officially** supported platforms: + +* Ubuntu Bionic on amd64/i386 +* Ubuntu Focal on amd64 +* (Ubuntu Jammy on amd64 once that's released) + +Platforms supported at **best-effort** include arm architectures, Windows and +macOS. See +[this ticket](https://github.com/ignition-tooling/release-tools/issues/596) +for the full status. diff --git a/garden/install.md b/garden/install.md index 882d47835..ff706f913 100644 --- a/garden/install.md +++ b/garden/install.md @@ -1,21 +1,9 @@ -# Garden Installation +# Ignition Garden -Up to Garden's release date, the collection should be considered unstable. - -For the moment, Garden supports the following platforms: - - * Ubuntu Bionic amd64/arm64/i386 and Focal on amd64/arm64 - * MacOS Catalina and BigSur - * Ignition currently only works in headless mode using Ogre 1 - (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use - `ign gazebo -s fuel.sdf` to start the server only). - * Windows 10 - * Ignition command line utilities are not yet supported. - * All packages up to `ign-gazebo` can be built. - * DART physics engine is not yet supported. - * Qt (GUI functionality) is not yet supported. +Ignition Garden will be the 7th major release of Ignition. It will be a +short-term release. -The supported platforms may change up to the release date. +Up to Garden's release date, the collection should be considered unstable. ## Binary installation instructions @@ -54,3 +42,18 @@ This list of library versions may change up to the release date. | ign-transport | 11.x | | ign-utils | 1.x | | sdformat | 12.x | + +## Supported platforms + +Garden is planned to be [supported](/docs/all/releases) on the platforms below. +This list may change up to the release date. + +These are the **officially** supported platforms: + +* Ubuntu Focal on amd64 +* Ubuntu Jammy on amd64 + +Platforms supported at **best-effort** include arm architectures, Windows and +macOS. See +[this ticket](https://github.com/ignition-tooling/release-tools/issues/597) +for the full status. diff --git a/index.yaml b/index.yaml index 595bdc6bc..c7c3585c3 100644 --- a/index.yaml +++ b/index.yaml @@ -43,12 +43,12 @@ pages: - name: release title: Release process file: release.md - description: Release process overview + description: Release process overview. unlisted: true - name: ci title: Continuous Integration file: ci.md - description: Continuous Integration overview + description: Continuous Integration overview. unlisted: true releases: - name: garden diff --git a/releases.md b/releases.md index 5a104526a..d7ac707bb 100644 --- a/releases.md +++ b/releases.md @@ -57,3 +57,38 @@ Ign-(N+2) | void bar(); Check out [this table](https://github.com/ignitionrobotics/docs/blob/master/tools/versions.md) for a list of release and EOL dates for all versions of all libraries. + +### Supported platforms + +Platforms are defined as a combination of operating system and architecture. +For example, "Ubuntu Focal on amd64". + +Each release is targeted at a specific set of platforms. A support level applies +to an entire Ignition release, including all library versions within it. The +supported platforms for each release are listed on their home pages (i.e. +[Fortress](https://ignitionrobotics.org/docs/fortress)). + +In general, there are three categories of support for a platform: + +* **Official support**: Officially supported platforms are regularly tested on + continuous integration and released as binary packages. Errors or bugs + discovered in these platforms are prioritized for correction by the + development team. Significant errors discovered in these platforms can impact + release dates and we strive to resolve all known high priority errors in + officially supported platforms prior to new version releases. +* **Best-effort support**: Platforms supported at best-effort may be regularly + tested on continuous integration and / or released as binary packages. Errors + may be present in released versions for these platforms. Known errors in + best-effort platforms will be addressed subject to resource availability on a + best-effort basis and may or may not be corrected prior to new releases. +* **No effort to support**: All platforms not included under official or + best-effort support are considered not supported. If a release is functional + in a platform that isn't supported at a point in time, there are no guarantees + that it will remain so in the future. Pull requests addressing issues on these + platforms may be considered if they don't break any supported platforms and + reviewed as time allows. + +If you or your company are interested in directly supporting, or +sponsoring the support of other platforms, please contact +`info@openrobotics.org`. +