Skip to content

Conversation

@HerbertsVaadin
Copy link
Contributor

Solves #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.

@github-actions
Copy link

github-actions bot commented Oct 17, 2025

AI Language Review

The key differences and issues in the updated documentation involve a few adjustments:

  1. Additional Information on Gradle Configuration: There is a new reference to the "Gradle Configuration Properties" page. Ensure that this page is available and accurately linked in the text.

  2. Requirements Section: The updated version includes a note on installing Node.js and npm automatically. It's advisable to verify this behavior with the actual plugin functionality. Also, ensure consistency in mentioning minimum versions of Gradle across the document.

  3. Version Update for Plugins: Plugin versions have been updated (e.g., from Gretty version 3.0.3 to 4.1.1). Ensure these reflect the correct versioning needed for compatibility with other components (such as Vaadin).

  4. "Gradle Files in Starter Projects" Section Created: A new section outlining Gradle-related files in starter projects has been added. Ensure it aligns with other sections that reference or elaborate on build scripts, especially if referencing specific files or functionality.

  5. Consistency in Terminal Commands: In various sections, both ./gradlew and gradlew are specified for Unix/Mac and Windows bash environments. Maintain uniformity in explaining this to avoid any confusion.

Check the integration within the documentation for all new references and sections created, ensuring they provide value and correctness in guidance.

@HerbertsVaadin HerbertsVaadin force-pushed the chore/move-gradle-content branch 2 times, most recently from afd1b32 to 7718ac0 Compare October 20, 2025 09:57
@HerbertsVaadin
Copy link
Contributor Author

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.

@mshabarov mshabarov requested a review from mcollovati October 20, 2025 11:34
.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.
Copy link
Contributor

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.

Comment on lines 218 to 226
dependencies {
classpath group: 'com.vaadin',
name: 'vaadin-gradle-plugin',
version: '24.0-SNAPSHOT'
}
Copy link
Contributor

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

Copy link
Contributor Author

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.

@HerbertsVaadin HerbertsVaadin force-pushed the chore/move-gradle-content branch from 35d1036 to 22bb817 Compare October 27, 2025 10:16
@HerbertsVaadin HerbertsVaadin added the target/main cherry pick to main branch label Oct 27, 2025
@mshabarov mshabarov merged commit eaa0b1a into v24 Oct 27, 2025
4 checks passed
@mshabarov mshabarov deleted the chore/move-gradle-content branch October 27, 2025 13:00
vaadin-bot pushed a commit that referenced this pull request Oct 27, 2025
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cherry-picked-main target/main cherry pick to main branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants