docs: document the Vaadin Eclipse plugin as the recommended way to run with hotswap - #5884
Merged
Conversation
The page claimed that Vaadin has no official plugin for Eclipse IDE and only described the manual JetBrains Runtime + HotswapAgent setup. The Vaadin plugin for Eclipse now bundles HotswapAgent and adds a "Debug using Hotswap Agent" launch shortcut, so document that as the recommended way and keep the manual setup as the alternative. Also drop the outdated "Eclipse development workflow is not supported yet" Copilot screenshot and describe the expected result instead. Fixes #5833
- Use the real Eclipse settings path for adding JetBrains Runtime. - Drop the undo claim, which the Copilot reference limits to IntelliJ. - Point plugin users to the verification section so they don't fall into the manual instructions. - Mention hotswap alongside Copilot on the Install an IDE page.
Preview DeploymentThis PR has been deployed for preview. URL: https://docs-preview-pr-5884.fly.dev Changed pagesAdded content is highlighted in green; removed content is marked in red on each page.
Built from 881e4fb |
Name the required JVM parameters in the manual hotswap step list, explain what each of them does in the debug configuration section, and note that the Vaadin plugin passes its own equivalents so nothing has to be added by hand.
Describe where the plugin installs its bundled agent and how it launches it, correct the description of -XX:+ClassUnloading, add explicit anchors for the headings that are linked to, and mention the Eclipse route on the HotswapAgent live reload page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Run in Eclipse IDE page still claimed that Vaadin has no official plugin for Eclipse IDE, and only described the manual JetBrains Runtime + HotswapAgent setup. The Vaadin plugin for Eclipse now bundles HotswapAgent and contributes a Debug using Hotswap Agent launch shortcut, so that is now documented as the recommended route, with the manual setup kept as the alternative.
Fixes #5833
What changed
run/eclipse.adoc.vaadin/eclipse-plugin/hotswap-agent.jarin the user's home directory, that the plugin picks up any JetBrains Runtime Eclipse knows about, and that it creates anApplication [Hotswap]debug configuration which starts the agent via-javaagentand adds the remaining JVM parameters. Plugin users are pointed straight at the new Verifying the Setup section so they don't accidentally follow the manual instructions.-XX:+AllowEnhancedClassRedefinition,-XX:+ClassUnloading,-XX:HotswapAgent=fatjar), and Debug Configuration describes what each one does. The-XX:+ClassUnloadingdescription is corrected: it's the JVM default and is passed explicitly only to make sure it isn't turned off elsewhere. Added a reminder that these go in VM arguments, not Program arguments.copilot-development-workflow-eclipse2.pngscreenshot and its "Vaadin does not have an official plugin for Eclipse IDE" caption, replacing it with a description of the expected result and what an orange item means.enabling-hotswap-using-the-vaadin-plugin,debug-configuration,verifying-the-setup) for the headings that are now cross-linked, and updated the page's meta description.Other pages
configuration/live-reload/hotswap-agent.adoc: mentions the Eclipse plugin route alongside the existing IntelliJ and VS Code ones.dev-environment/install-ide.adoc: notes that the Eclipse plugin is needed for hotswap, not just Copilot integration..github/styles/config/vocabularies/Docs/accept.txt: addedJREsto the Vale vocabulary.