documentation: include migration guide

[vince-fugnitto]

What it does

The pull-request introduces a migration guide to the framework to help downstream extensions and applications migrate to newer versions of the framework.

How to test

• verify documentation content.

Review checklist

• as an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

• as a reviewer, I agree to behave in accordance with the review guidelines

Signed-off-by: vince-fugnitto [email protected]

[vince-fugnitto]

I'll leave the pull-request as a draft to see if anyone has any feedback over the content, or format of the initial migration guide of the framework.

[tsmaeder]

Good start! As we discussed in the community call, the migration guide is supposed to be a living document initiated by the feature author and improved as adopters migrate to new releases.

[vince-fugnitto]

@paul-marechal should we add some entry about what you discovered, mainly how you can opt to not use the pre-built binaries for keytar and instead build it for your operating system if you run into issues?

• https://github.com/eclipse-theia/theia/pull/9707/files#diff-be1156289fcb3cf2ac512dbea9fafba086b6d1494cfa8b90a850734a04f6e5f4R82-R94

[vince-fugnitto]

@marcdumais-work I think the initial version of the document is good, it should be updated when adopters notice additional migration steps that might be required after releases 👍

[vince-fugnitto]

@azatsarynnyy I updated the migration and the prerequisites to include an alpine entry for keytar.

[azatsarynnyy]

@azatsarynnyy I updated the migration and the prerequisites to include an alpine entry for keytar.

Thank you @vince-fugnitto!