-
Couldn't load subscription status.
- Fork 213
Update gradle documentation, split it into two pages. #4669
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
Conversation
AI Language ReviewThe key differences and issues in the updated documentation involve a few adjustments:
Check the integration within the documentation for all new references and sections created, ensuring they provide value and correctness in guidance. |
afd1b32 to
7718ac0
Compare
|
I think the remaining AI Language Review suggestions can be ignored, I think it's unaware that the original document has been split into two, and more focused / less-verbose approach of the document is desired. |
| .Requirements | ||
| [NOTE] | ||
| The Vaadin Gradle plugin requires Java SDK 17 or later, Gradle 8.5 or later. | ||
| It will install Node.js and npm automatically when running the build for the first time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It could be worth it adding that install happens only if Node is not already installed or if it does not match the minimum version required by Vaadin.
| dependencies { | ||
| classpath group: 'com.vaadin', | ||
| name: 'vaadin-gradle-plugin', | ||
| version: '24.0-SNAPSHOT' | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not so skilled in Gradle, but at least our starter seems to provide a different plugin configuration.
It has the version pinned in settings file (https://github.com/vaadin/base-starter-gradle/blob/9a8284e07d02e0f6f346b49accbebd902e50865a/settings.gradle#L7) and only definition in the build script (https://github.com/vaadin/base-starter-gradle/blob/9a8284e07d02e0f6f346b49accbebd902e50865a/build.gradle#L15), no apply at all.
So the question is if it would be enough to set the snapshot version in settings in combination with the configuration of the pre-release repository.
I'm not sure what we should suggest in the docs. Maybe @mvysny can provide some insight
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've updated to a modernized version, seems like the "apply" approach is historic. Please check.
35d1036 to
22bb817
Compare
Fixes #4222 Changes: Removed the "Developing in Eclipse IDE" section - unnecessary, not Vaadin specific information, if you use Gradle, and have chosen to use Gradle, and use Eclipse, you probably know how to import and run gradle application in Eclipse IDE. Reduced requirements section to a note - unecessary to have so much detail. Reduced starter project contents to only gradle-related files Reduced section "The most important files and folders are as follows" to only reference gradle related files, since the rest is the same between other build tools. Simplified compile section, referenced configuration page Removed warning about Gretty + jcenter, as it is no longer relevant. Created new page under flow/configuration specific to Gradle configuration properties. Refactored Configuring repositories section, removed focus from pre-releases. Removed the build file "Other Configuration" section, as its no longer valid.
Solves #4222
Changes: