Skip to content
This repository has been archived by the owner on May 6, 2021. It is now read-only.

fix: improve the Quick Start and Migrating from Vaadin 14 pages #970

Merged
merged 8 commits into from
Dec 27, 2019

Conversation

vlukashov
Copy link
Contributor

@vlukashov vlukashov commented Dec 27, 2019

Upgrading from Vaadin 14

  • fix: mention Vaadin Maven plugin
    Explicitly mention that the plugin version needs to be changed as well, so that the project uses matching versions of the Vaadin platform and the Vaadin Maven plugin.
  • fix: replace npm with pnpm
    This is needed after pnpm became the default front-end package manager in Vaadin apps (see Use pnpm instead of npm for frontend resources flow#6966)
  • fix: clarify where to run the pnpm install command
  • fix: add a tip that JS is supported as well as TS
  • fix: add a step to move existing Java views into a TS page layout

Quick Start Guide

  • fix: avoid TS compilation errors in code snippets
    • the route.action property does not allow returning a promise of a particular ES module, thus action: () => import('./views/help/app-help') does not pass the type check
    • the click() method in the snippet overrides the HTMLElement's click property, which is not intended
  • fix: add an import for the vaadin-button custom element used in a code snippet

This addresses comments from the recent DX tests.


This change is Reviewable

Explicitly mention that the plugin version needs to be changed as well, so that the project uses matching versions of the Vaadin platform and the Vaadin Maven plugin.

This addresses one of the comments from DX tests.
@vlukashov vlukashov added fusion CCDM related documentations DX labels Dec 27, 2019
Viktor Lukashov added 7 commits December 27, 2019 15:37
This is needed after `pnpm` became the default front-end package manager in Vaadin apps (see vaadin/flow#6966)
 - the `route.action` property does not allow returning a promise of a particular ES module, thus `action: () => import('./views/help/app-help')` does not pass the type check
 - the `click()` method in the snippet overrides the `HTMLElement`'s `click` property, which is not intended
 - add an import for the `vaadin-button` custom element used in the snippet
 - into the 'upgrading from V14' guide
@vlukashov vlukashov changed the title fix: mention Vaadin Maven plugin in the 'upgrading from Vaadin 14' guide fix: improve the Quick Start and Migrating from Vaadin 14 pages Dec 27, 2019
Copy link
Contributor

@platosha platosha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 3 of 3 files at r1.
Reviewable status: :shipit: complete! all discussions resolved, 1 of 1 LGTMs obtained

@platosha platosha merged commit 404c0b7 into ccdm Dec 27, 2019
@platosha platosha deleted the vl/fix-quick-upgrade-guide-mention-vaadin-maven-plugin branch December 27, 2019 15:54
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
DX fusion CCDM related documentations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants