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

Reorganize platform support documentation and add Harmonic #360

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

azeey
Copy link
Contributor

@azeey azeey commented May 19, 2023

This consolidates all the platform support documentation into the releases page. I thought it would be better to see all the support information in one page much like REP 2000. @j-rivero we can expand on this to add more documentation on dependency requirements.

This also adds the list of platforms we plan to support in Harmonic. Per our discussion this week, Focal will not be supported in Harmonic.

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
@azeey azeey requested a review from mabelzhang as a code owner May 19, 2023 16:42
@github-actions github-actions bot added 🌱 garden Gazebo Garden 🏢 edifice Ignition Edifice 🏯 fortress Ignition Fortress 🏰 citadel Ignition Citadel 🔮 dome Ignition Dome labels May 19, 2023
releases.md Outdated Show resolved Hide resolved
releases.md Outdated Show resolved Hide resolved
releases.md Outdated Show resolved Hide resolved
releases.md Outdated Show resolved Hide resolved
releases.md Outdated Show resolved Hide resolved
releases.md Outdated Show resolved Hide resolved
azeey and others added 2 commits May 22, 2023 11:35
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Addisu Z. Taddese <addisuzt@intrinsic.ai>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Addisu Z. Taddese <addisuzt@intrinsic.ai>
@azeey
Copy link
Contributor Author

azeey commented May 22, 2023

@ahcorde I've applied all the suggestions. PTAL.

@j-rivero
Copy link
Contributor

Great!

@j-rivero we can expand on this to add more documentation on dependency requirements.

Don't want to transform it into the REP 2000 but let's copy some of the details in there, like some platform versions and details needed:

  • Mac/Windows versions to be supported
  • C++ standard used by the release is relevant.
  • OpenGL version / Vulkan version

For other important dependencies:

  • Python/Ruby version supported by the release is also relevant.
  • Ogre1 / Ogre-next versions supported
  • Qt/QML version supported
  • Dart/Bullet versions supported

For compatibility:

  • Compatibility with ROS 2: not sure here if we should only go with declaring binary ROS repo official compatibility (i.e: Fortress -> ROS Humble) or also mention the from-source options. We can just mention the former and point people to the ros_installation document.

[this ticket](https://github.com/gazebo-tooling/release-tools/issues/597)
for the full status.

## Harmonic (Planned)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Harmonic (Planned)
## Harmonic


## Harmonic (Planned)

Harmonic is planned to be supported on the platforms below.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Harmonic is planned to be supported on the platforms below.
Harmonic is supported on the platforms below.

## Harmonic (Planned)

Harmonic is planned to be supported on the platforms below.
This list may change up to the release date.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This list may change up to the release date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice 🏯 fortress Ignition Fortress 🌱 garden Gazebo Garden
Projects
Status: To do
Development

Successfully merging this pull request may close these issues.

4 participants