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

Doc upgrade guide #6231

Merged
merged 78 commits into from
Jun 26, 2023
Merged

Doc upgrade guide #6231

merged 78 commits into from
Jun 26, 2023

Conversation

BenjaminDeleze
Copy link

@BenjaminDeleze BenjaminDeleze commented Jun 19, 2023

Description

  • Add a new section in the user guide: Upgrading Webots
  • Insert in the user guide the conversion guides that were present on the wiki
  • Add a new conversion guide for 2023a->R2023b
  • Change the welcome message to redirect to the user guide.
  • make update the translations

Fix #6209

Check the new documentation pages here: https://cyberbotics.com/doc/guide/upgrading-webots?version=doc-upgrade-guide

I will delete the page on the wiki once this PR is merged

@BenjaminDeleze BenjaminDeleze added the documentation Improve or fix the documentation (MD files only, no software development) label Jun 19, 2023
@BenjaminDeleze BenjaminDeleze added this to the R2023b milestone Jun 19, 2023
@BenjaminDeleze BenjaminDeleze self-assigned this Jun 19, 2023
@BenjaminDeleze BenjaminDeleze marked this pull request as ready for review June 20, 2023 11:39
@BenjaminDeleze BenjaminDeleze requested a review from a team as a code owner June 20, 2023 11:39
Copy link
Member

@stefaniapedrazzi stefaniapedrazzi left a comment

Choose a reason for hiding this comment

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

Thank you!
I found a couple of typos, and we should pay attention to the spelling of PROTO.
Then, I have a couple of comments:

  • I would list the pages in the reverse order, i.e the first one should be the page to convert to the most recent version of Webots
    *Maybe I would also rename the scripts scripts/converter/convert_nue_to_enu_rub_to_flu.py and scripts/converter/declare_externproto.py to make it clear that converts to R2022a/R2022b only.

docs/guide/upgrading-webots.md Outdated Show resolved Hide resolved
docs/guide/upgrading-webots.md Outdated Show resolved Hide resolved
docs/guide/upgrading-webots.md Outdated Show resolved Hide resolved
docs/guide/upgrading-webots.md Outdated Show resolved Hide resolved
docs/guide/upgrading-webots.md Outdated Show resolved Hide resolved
docs/guide/from-2023a-to-2023b.md Outdated Show resolved Hide resolved
docs/guide/from-2023a-to-2023b.md Outdated Show resolved Hide resolved
docs/guide/from-2023a-to-2023b.md Outdated Show resolved Hide resolved
docs/guide/from-2023a-to-2023b.md Outdated Show resolved Hide resolved
docs/guide/from-2023a-to-2023b.md Outdated Show resolved Hide resolved
Benjamin Délèze and others added 9 commits June 21, 2023 09:24
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Copy link
Member

@omichel omichel left a comment

Choose a reason for hiding this comment

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

I believe we should explain that backward compatibility breaking changes are listed in bold in the change logs.

docs/guide/from-2021b-to-2022a.md Outdated Show resolved Hide resolved
omichel
omichel previously approved these changes Jun 23, 2023
Copy link
Member

@omichel omichel left a comment

Choose a reason for hiding this comment

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

Thank you.

Copy link
Member

@stefaniapedrazzi stefaniapedrazzi left a comment

Choose a reason for hiding this comment

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

Thank you!

I just found a couple of words whose case was not the original one.

docs/guide/from-2021b-to-2022a.md Outdated Show resolved Hide resolved
docs/guide/from-2022a-to-2022b.md Outdated Show resolved Hide resolved
docs/guide/from-2022a-to-2022b.md Outdated Show resolved Hide resolved
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Benjamin Délèze and others added 3 commits June 26, 2023 15:49
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Copy link
Member

@stefaniapedrazzi stefaniapedrazzi left a comment

Choose a reason for hiding this comment

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

Thank you!

@BenjaminDeleze BenjaminDeleze merged commit cdd2794 into master Jun 26, 2023
@BenjaminDeleze BenjaminDeleze deleted the doc-upgrade-guide branch June 26, 2023 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve or fix the documentation (MD files only, no software development)
Development

Successfully merging this pull request may close these issues.

Update Welcome to Webots R2023b window
3 participants