docs: update offline license key docs for License Checker 2.3.1 backport (v24)#5819
Open
mcollovati wants to merge 3 commits into
Open
docs: update offline license key docs for License Checker 2.3.1 backport (v24)#5819mcollovati wants to merge 3 commits into
mcollovati wants to merge 3 commits into
Conversation
AI Language ReviewIn the reviewed file, the following issues need improvement:
The rest of the content you provided appears necessary and relevant, enhancing the clarity and completeness of the documentation. |
mcollovati
force-pushed
the
docs/license-checker-2.3.1-offline-key-v24
branch
from
July 17, 2026 05:07
accb4c7 to
f7b14f0
Compare
mid2/offlineKeyV2 support was backported to Vaadin 24.9, so it is no longer exclusive to 24.10+. Update the mid2 since badge to V24.9, the machine ID compatibility table, and the offline key retrieval guidance. The download-offline-license Maven goal remains 24.10+ only, and the OSHI note stays V24.10 (OSHI is still bundled in License Checker 2.3.1).
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
force-pushed
the
docs/license-checker-2.3.1-offline-key-v24
branch
from
July 17, 2026 05:21
f7b14f0 to
c27a314
Compare
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.
Updates the license documentation for the License Checker 2.3.1 backport, which brings
mid2/offlineKeyV2support to Vaadin 24.9.Changes
articles/flow/configuration/licenses/index.adoc: change themid2sincebadgeV24.10→V24.9; update the machine-ID table (mid2/offlineKeyV2for 24.9 and later,mid/offlineKeyfor 24.8 and earlier); correct the IMPORTANT box. The OSHI note staysV24.10(OSHI is still bundled in License Checker 2.3.1), and thedownload-offline-licensegoal stays 24.10+.articles/flow/kb/index.adoc(license troubleshooting):mvn -X/./gradlew --debugdiagnosis tip.Docs issue: #5817
Related License Checker issue: vaadin/license-checker-vaadin10#245