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

Update plugin API docs for headless plugins and Inversify DI #13299

Merged
merged 3 commits into from
Jan 23, 2024

Conversation

cdamus
Copy link
Contributor

@cdamus cdamus commented Jan 21, 2024

What it does

Update the plugin API documentation to cover

How to test

Read and critique the updated documentation pages at

Follow-ups

No further documentation changes are identified at this time.

Review checklist

Reminder for reviewers

Update the plugin API documentation to cover

- headless plugins
- Inversify DI in the plugin host
- simplified ext API initialization and API factory using new
  PluginContainerModule capability

Fixes eclipse-theia#13290

Signed-off-by: Christian W. Damus <[email protected]>
Copy link
Contributor

@martin-fleck-at martin-fleck-at 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 very much for that great update, Christian! I have a few comments and may also ask other people to chime. Really grateful you also fixed some of the typos ;-)

doc/Plugin-API.md Outdated Show resolved Hide resolved
doc/Plugin-API.md Outdated Show resolved Hide resolved
doc/Plugin-API.md Outdated Show resolved Hide resolved
doc/Plugin-API.md Outdated Show resolved Hide resolved
doc/Plugin-API.md Outdated Show resolved Hide resolved
@JonasHelming
Copy link
Contributor

Should this maybe also be mentioned here: https://theia-ide.org/docs/extensions/

@martin-fleck-at
Copy link
Contributor

@JonasHelming Very good point! I fully agree that we should also mention in on the website doc!

- address specific review comments, generally clarifying the text
- rationalize sentence forms of bullet lists
- add a diagram showing the subtle difference in architecture of the
  VS Code plugin hosts and headless plugin host

Signed-off-by: Christian W. Damus <[email protected]>
@cdamus
Copy link
Contributor Author

cdamus commented Jan 22, 2024

Thanks @martin-fleck-at for the thorough review. Very helpful! I've pushed commit 7063d6e that I hope should address your comments. Updates to the website will require a separate PR on that repository.

@cdamus
Copy link
Contributor Author

cdamus commented Jan 22, 2024

Should this maybe also be mentioned here: https://theia-ide.org/docs/extensions/

Done: eclipse-theia/theia-website#502

doc/Plugin-API.md Outdated Show resolved Hide resolved
doc/Plugin-API.md Outdated Show resolved Hide resolved
@jcortell68
Copy link
Contributor

@cdamus Great job with this new documentation. With the new plugin type in the mix, this stuff is even trickier to explain than it was before. You did so as best as it could have been done, IMO.

- minor updates to the text for better clarity and precision

Signed-off-by: Christian W. Damus <[email protected]>
@cdamus
Copy link
Contributor Author

cdamus commented Jan 22, 2024

Thanks @jcortell68 for the review! Commit 2ed73f3 should be better than ever.

Copy link
Contributor

@jcortell68 jcortell68 left a comment

Choose a reason for hiding this comment

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

Looks great. Thanks for the adjustments!

@cdamus
Copy link
Contributor Author

cdamus commented Jan 23, 2024

Quick-fix action test failures on Ubuntu Linux are the same as occurred in the commit(s) on which this PR is based, so not a regression in this PR.

Copy link
Contributor

@martin-fleck-at martin-fleck-at left a comment

Choose a reason for hiding this comment

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

@cdamus Thank you very much for the enhanced documentation! I think that adds great value, especially with new images and further clarifications.

@martin-fleck-at martin-fleck-at merged commit aeee83b into eclipse-theia:master Jan 23, 2024
11 of 14 checks passed
@cdamus cdamus deleted the issues/13290-plugin-docs branch January 23, 2024 14:04
@jfaltermeier jfaltermeier added this to the 1.46.0 milestone Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants