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

docs: v12 migration guide [LIBS-689] #884

Merged
merged 29 commits into from
Nov 5, 2024
Merged

Conversation

KaiVandivier
Copy link
Contributor

@KaiVandivier KaiVandivier commented Oct 17, 2024

LIBS-689

  • Needs some React 18 info
  • Add last bit of React 18 info after final tests
  • Some information about env vars is pending some discussion

docs/migration/v12.md Outdated Show resolved Hide resolved
@KaiVandivier KaiVandivier requested a review from a team October 30, 2024 09:30
@Topener Topener self-requested a review October 30, 2024 10:20
Copy link
Contributor

@Topener Topener left a comment

Choose a reason for hiding this comment

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

First of all, amazing guide. It looks very detailed and exhaustive.

I went through the guide with a very nit-picky and oblivious point-of-view, so I added a grand total of 21 comments and suggestions to make it easier to read and contextually make sense.

docs/migration/v12.md Outdated Show resolved Hide resolved
docs/migration/v12.md Outdated Show resolved Hide resolved
docs/migration/v12.md Outdated Show resolved Hide resolved
docs/migration/v12.md Outdated Show resolved Hide resolved
docs/migration/v12.md Outdated Show resolved Hide resolved

Here are some edge cases that were encountered when upgrading some apps with the new platform version:

- There is a bug in Vite: importing from a directory, e.g. `‘./app/‘` where we would assume to get `./app/index.[jt]s`, can incorrectly resolve to a file with a similar name to the directory, e.g. `./App.tsx`. I see this as a bug with Vite, but as a workaround, file and dir names can be changed so they don’t conflict. Noticed in the Maintenance app beta.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can the Maintenance app example be linked/explained?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's probably best just to remove the mention, which I've done -- I think the rest of the comment is enough info. I've also removed similar "noticed in ___" mentions

docs/migration/v12.md Outdated Show resolved Hide resolved
docs/migration/v12.md Outdated Show resolved Hide resolved
docs/migration/v12.md Outdated Show resolved Hide resolved
docs/migration/v12.md Outdated Show resolved Hide resolved
KaiVandivier and others added 7 commits November 1, 2024 17:47
Co-authored-by: Rene Pot <Topener@users.noreply.github.com>
Co-authored-by: Rene Pot <Topener@users.noreply.github.com>
Co-authored-by: Rene Pot <Topener@users.noreply.github.com>
Copy link
Contributor

@Topener Topener left a comment

Choose a reason for hiding this comment

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

Awesome! Great work!

@KaiVandivier KaiVandivier merged commit 56bbfd4 into alpha Nov 5, 2024
6 checks passed
@KaiVandivier KaiVandivier deleted the migration-guide-docs branch November 5, 2024 12:12
@dhis2-bot
Copy link
Contributor

🎉 This PR is included in version 12.0.0-alpha.22 🎉

The release is available on:

Your semantic-release bot 📦🚀

@dhis2-bot
Copy link
Contributor

🎉 This PR is included in version 12.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants