Enhancement: extend `spfx project upgrade` documentation

Jwaegebaert commented 2 years ago

As mentioned in #3161, it would be interesting to write more documentation regarding the command spfx project upgrade. This would then be the various aspects that we all take into account to make the upgrade report.

This could be, for example.

It will be important to upgrade your .yo-rc.json file to the corresponding SPFx version
If you are making use of the package spfx-fast-serve-helpers you will get the recommendation to update it.
...

Here I think it will be an interesting idea to place a scope of what aspects we will mention. So that we don't necessarily have to document the obvious aspects.

To visually tie it into the documentation, it might be an idea to put it into a table.

What is your opinion on this matter?

waldekmastykarz commented 2 years ago

I think it's a great suggestion! We should not only mention the importance of updating the version in .yo-rc.json but also document all findings that we report to increase transparency.

Jwaegebaert commented 1 month ago

This should be safe to close as well as it's been majorly implemented here: https://pnp.github.io/cli-microsoft365/concepts/how-it-works/spfx-project-upgrade

pnp / cli-microsoft365

Enhancement: extend `spfx project upgrade` documentation #3164