Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document platform support tiers for all collections #215

Merged
merged 11 commits into from
Dec 23, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 52 additions & 14 deletions citadel/install.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -52,3 +40,53 @@ 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.

### Official support

* Ubuntu Bionic on amd64/i386
* Ubuntu Focal on amd64

### Best-effort support

* Ubuntu Bionic on arm64
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* Ubuntu Focal on arm64
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* Ubuntu Bionic on armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* DART physics engine not available
* Ubuntu Focal on armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* DART physics engine not available
* Debian Buster on amd64, i386, arm64 and armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* MacOS Mojave
* Binary packages may be available
* Tested on CI
* Ignition 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
* Binary packages may be available
* Some libraries tested on CI
* Ignition command line utilities are not supported.
* All packages up to but not including `ign-gazebo` are currently building.
* DART physics engine is not supported.
* Qt (GUI functionality) is not supported.
chapulina marked this conversation as resolved.
Show resolved Hide resolved
66 changes: 52 additions & 14 deletions dome/install.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -52,3 +40,53 @@ 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.

### Official support

* Ubuntu Bionic on amd64/i386
* Ubuntu Focal on amd64

### Best-effort support

* Ubuntu Bionic on arm64
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* Ubuntu Focal on arm64
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* Ubuntu Bionic on armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* DART physics engine not available
* Ubuntu Focal on armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* DART physics engine not available
* Debian Buster on amd64, i386, arm64 and armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* MacOS Mojave and Catalina
* Binary packages may be available
* Tested on CI (TODO which version exactly?)
* Ignition 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
* Binary packages may be available
* Some libraries tested on CI
* Ignition command line utilities are not supported.
* All packages up to but not including `ign-gazebo` are currently building.
* DART physics engine is not supported.
* Qt (GUI functionality) is not supported.
66 changes: 52 additions & 14 deletions edifice/install.md
Original file line number Diff line number Diff line change
@@ -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 Dome

Ignition Dome is the 5th major release of Ignition. It's a short-term support.

## Binary installation instructions

Expand Down Expand Up @@ -53,3 +41,53 @@ 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.

### Official support

* Ubuntu Bionic on amd64/i386
* Ubuntu Focal on amd64

### Best-effort support

* Ubuntu Bionic on arm64
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* Ubuntu Focal on arm64
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* Ubuntu Bionic on armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* DART physics engine not available
* Ubuntu Focal on armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* DART physics engine not available
* Debian Buster on amd64, i386, arm64 and armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* MacOS Mojave and Catalina
* Binary packages may be available
* Tested on CI (TODO which version exactly?)
* Ignition 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
* Binary packages may be available
* Tested on CI
* Ignition command line utilities are not supported.
* All packages up to but not including `ign-gazebo` are currently building.
* DART physics engine is not supported.
* Qt (GUI functionality) is not supported.
66 changes: 53 additions & 13 deletions fortress/install.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -59,3 +48,54 @@ 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.

### Official support

* Ubuntu Bionic on amd64/i386
* Ubuntu Focal on amd64
* (Ubuntu Jammy on amd64 once that's released)

### Best-effort support

* Ubuntu Bionic on arm64
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* Ubuntu Focal on arm64
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* Ubuntu Bionic on armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* DART physics engine not available
* Ubuntu Focal on armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* DART physics engine not available
* Debian Buster on amd64, i386, arm64 and armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* MacOS Catalina and BigSur
* Binary packages may be available
* Tested on CI (TODO which version exactly?)
* Ignition 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
* Binary packages may be available
* Tested on CI
* Ignition command line utilities are not supported.
* All packages up to but not including `ign-gazebo` are currently building.
* DART physics engine is not supported.
* Qt (GUI functionality) is not supported.
71 changes: 55 additions & 16 deletions garden/install.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,9 @@
# Garden Installation
# Garden Fortress

Up to Garden's release date, the collection should be considered unstable.

For the moment, Garden supports the following platforms:
Ignition Garden will be the 7th major release of Ignition. It will be a
short-term release.

* 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.

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

Expand Down Expand Up @@ -54,3 +42,54 @@ 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.

### Official support

* Ubuntu Focal on amd64
* Ubuntu Jammy on amd64

### Best-effort support

* Ubuntu Bionic on arm64
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* Ubuntu Focal on arm64
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* Ubuntu Bionic on armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* DART physics engine not available
* Ubuntu Focal on armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* DART physics engine not available
* Debian Buster on amd64, i386, arm64 and armhf
* Binary packages may be available
* Not tested on CI
* Most low-level libraries known to work
* TODO: what is know not to work?
* MacOS Catalina and BigSur
* Binary packages may be available
* Tested on CI (TODO which version exactly?)
* Ignition 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
* Binary packages may be available
* Tested on CI
* Ignition command line utilities are not supported.
* All packages up to but not including `ign-gazebo` are currently building.
* DART physics engine is not supported.
* Qt (GUI functionality) is not supported.
4 changes: 2 additions & 2 deletions index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading