Skip to content

docs: update offline license key docs for License Checker 2.3.1 backport (v25)#5818

Open
mcollovati wants to merge 3 commits into
mainfrom
chore/update-license-docs
Open

docs: update offline license key docs for License Checker 2.3.1 backport (v25)#5818
mcollovati wants to merge 3 commits into
mainfrom
chore/update-license-docs

Conversation

@mcollovati

@mcollovati mcollovati commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Updates the license documentation for the License Checker 2.3.1 backport, which brings mid2/offlineKeyV2 support to the maintained minors (14.14, 23.6, 24.9).

Changes

  • articles/flow/configuration/licenses/index.adoc: drop the "since License Checker version 3" attribution for mid2; machine-ID compatibility table now lists mid2/offlineKeyV2 for 14.14+, 23.6+, 24.9+, and all 25.x; correct the IMPORTANT box (the mid2 key is no longer exclusive to 24.10+, but the download-offline-license goal stays 24.10+).
  • articles/flow/kb/index.adoc (license troubleshooting):
    • Expand the "Detected an offline license version 1, but version 2 is required" entry to explain it can mean the V1 machine ID could not be computed — commonly a blocked/failed JNA native library — with a mvn -X / ./gradlew --debug diagnosis tip.
    • Fix the stale "24.10 and later / 24.9 and earlier" claim in the "Invalid Offline Key" entry to match the backport.

Docs issue: #5817
Related License Checker issue: vaadin/license-checker-vaadin10#245

@mcollovati mcollovati added target/v25.2 Automatically cherry-pick to the v25.2 branch flow labels Jul 17, 2026
@github-actions

github-actions Bot commented Jul 17, 2026

Copy link
Copy Markdown

Preview Deployment

This PR has been deployed for preview.

URL: https://docs-preview-pr-5818.fly.dev

Changed pages

Added content is highlighted in green; removed content is marked in red on each page.

Built from 90cc490

@mcollovati
mcollovati force-pushed the chore/update-license-docs branch from 1347519 to 849b567 Compare July 17, 2026 05:06
mid2/offlineKeyV2 support was backported to Vaadin 14.14, 23.6, and 24.9,
so it is no longer exclusive to 24.10+/License Checker 3. Update the
machine ID compatibility table and offline key retrieval guidance
accordingly. The download-offline-license Maven goal remains 24.10+ only.
Explain that the 'Detected an offline license version 1, but version 2
is required' message can also mean the version 1 machine ID could not be
computed -- commonly because the JNA native library is blocked or fails
to load -- and point users to mvn -X to find the real error. Also update
the Invalid Offline Key entry so the version mismatch guidance matches
the License Checker 2.3.1 backport (mid2/offlineKeyV2 in 14.14, 23.6,
24.9 and later; download-offline-license goal still 24.10+).
- Add 'backported' to the docs vocabulary (Vale.Spelling).
- Add JNA and OSHI to the Vaadin.Abbr exceptions.
- Wrap version-specific offline-key guidance in Vaadin.Versions = NO/YES,
  matching the pattern already used elsewhere in the docs.
@mcollovati
mcollovati force-pushed the chore/update-license-docs branch from 849b567 to 86c3352 Compare July 17, 2026 05:21
Comment thread articles/flow/configuration/licenses/index.adoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

flow target/v25.2 Automatically cherry-pick to the v25.2 branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants