search

gazebosim / docs

High-level Gazebo documentation that gets published to https://gazebosim.org/docs/
https://gazebosim.org/docs
48 stars 117 forks source link

Change get_started to recommened Gz version per platform for installations #338

Closed j-rivero closed 1 year ago

j-rivero commented 1 year ago

🎉 New feature

Summary

The PR tries to simplify the election of the Gz version for the users. Basically it provides a recommendation in the landing page of main docs page https://gazebosim.org/docs and the landing page of releases (i.e https://gazebosim.org/docs/garden). It also includes a clear warning about Windows and leave it out of the table.

The PR will require some effort when we release a new version or when a version is EOL but I think that could worth it.

Current situation problems

I think that there is a number of issues currently that are a source of confusion:

Both points in combination cause the effect of: When being in a landing page of a given distribution (i.e Garden https://gazebosim.org/docs/garden), there are two links in the first step 1 install point named latest installation tutorial here and Please visit the main documentation pages for a list of all releases both are redirecting to Harmonic (development version).

Follow up work

A new PR to be sent to clarify the options for the ROS users in the same way that we have for gazebo-classic.

Checklist

j-rivero commented 1 year ago

Cosmetic corrections.

Thanks so much!

azeey commented 1 year ago

The Gz version selected by default in the top left corner named "Release" is the one in development which leaves the user without binary install methods.

@nkoenig is looking into making the current stable version the default. If that's not visible, we can remove Harmonic from https://github.com/gazebosim/docs/blob/master/index.yaml until we open the tutorial party.

j-rivero commented 1 year ago

Looks great! My only comment is that we replace all instances of Gz with Gazebo. I think adding another name (Gz) would only add to the confusion.

Good point. Changed in 0e2492a

I missed a quick reference to the EOL dates for the distributions and added that in a7b9883. Sorry for the inconvenience, @kscottz @mabelzhang @azeey if you can give it a quick look at that commit. Would be great.

azeey commented 1 year ago

@j-rivero if we can merge this in the next hour, I'll go ahead and deploy it with #341 .