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

Create Adopting.md #14589

Open
tsmaeder opened this issue Dec 5, 2024 · 3 comments
Open

Create Adopting.md #14589

tsmaeder opened this issue Dec 5, 2024 · 3 comments

Comments

@tsmaeder
Copy link
Contributor

tsmaeder commented Dec 5, 2024

Feature Description:

There are cases like #14586 where we cannot fix a problem for adopters in our own code. It would be good if we had some documentation for adopters on what they need to do when creating their own application. There is some documentation on theia-ide.org, but it's hard to keep that in sync with the actual code.

@vince-fugnitto
Copy link
Member

@tsmaeder note that https://github.com/eclipse-theia/theia/blob/master/doc/Migration.md exists, but perhaps it's clearer with the name you proposed and at the root of the repository.

@tsmaeder
Copy link
Contributor Author

tsmaeder commented Dec 6, 2024

Yes, that document is aimed at folks who adopt new releases, but we have no guidance in-repo about how to start a new Theia-based product.

@tortmayr
Copy link
Contributor

👍🏼 In my opinion a in-repo documentation for adopters would be a great addition.
Another case that should be mentioned there is a potential build error related to the inversify version.
This was fixed for Theia >=1.56 with #14435
However, if adopters start from scratch with an older version they need to manually lock (i.e. via resolutions) a compatible version.

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

No branches or pull requests

3 participants