Skip to content

docs: give the Getting Started front page Learn and Evaluate paths - #6482

Merged
peholmst merged 1 commit into
mainfrom
claude/gallant-moore-c98785
Oct 23, 2026
Merged

peholmst merged 1 commit into
mainfrom
claude/gallant-moore-c98785

Conversation

@peholmst

Copy link
Copy Markdown
Member

What

Restructures the Getting Started front page (articles/getting-started/index.adoc) so that it serves two readers: someone learning Vaadin, and someone evaluating it for a project. Before, the page sent everyone to a single Quick Start button and put the evaluation reading list in one long paragraph. It had no entry for existing applications, migration, or working with a REST API.

This builds on #6475 (Java framing) and #6477 (the Existing Applications page). The opening paragraphs from #6475 are unchanged.

The page now

  • Title: "Getting Started with Vaadin" instead of "Welcome to the Getting Started Guide!". page-title, meta-description, and description are unchanged.
  • Learn Vaadin: an ordered path. Quick Start, then the Tutorial (a Spring Boot application with a Vaadin UI), then Next Steps. The pointers to Development Environment and Starters stay here.
  • Evaluate Vaadin: an ordered reading list with a time estimate of about half an hour. When to Use Vaadin, How Vaadin Works at Runtime, Licensing, Support & Maintenance, and Supported Technologies. It ends with a pointer to the Architecture deep dives.
  • Start from Existing Code: a short description list for readers who already have code:
    • A Java application: Add a Vaadin UI to an Existing Application (docs: add Getting Started page for adding Vaadin to an existing application #6477)
    • A REST API or a separate backend: REST API Alongside Vaadin, and Call a Remote Service
    • A Swing application: SwingBridge, Swing Kit, and the Modernization Toolkit
    • An older Vaadin version: the Upgrading Guide, Version Comparison, Multiplatform Runtime (Vaadin 7 and 8), and the Modernization Toolkit

New links

The page didn't link to these before:

  • articles/getting-started/next-steps.adoc
  • articles/building-apps/architecture/index.adoc
  • articles/building-apps/integration/rest-api.adoc
  • articles/building-apps/integration/call-remote-services.adoc
  • articles/tools/modernization-toolkit/swing-bridge/index.adoc
  • articles/tools/swing/index.adoc
  • articles/tools/modernization-toolkit/index.adoc
  • articles/upgrading/index.adoc
  • articles/upgrading/version-comparison.adoc
  • articles/tools/mpr/index.adoc

All the other links were already there. No pages move, so no redirects are needed.

Notes for reviewers

  • Quick Start: on /docs/latest, the Quick Start currently redirects to vaadin.com/quickstart, which is part of a marketing experiment. I checked again today, and the redirect is still there. The Quick Start item promises only "a running application that you've changed yourself, in minutes", which is true for both versions. It doesn't name a duration, a view, or a production build.
  • No buttons or cards: a docs card makes its whole area one link, so a path with several steps can't be a card. The paths are plain ordered lists, which keeps the page short. The Quick Start button is gone, so that neither path stands out more than the other. The docs front page still links straight to the Quick Start.
  • Licensing: the migration tools aren't labeled as commercial, following the practice of leaving product-to-tier mapping to vaadin.com/pricing. Their own pages carry the commercial banner.
  • JSF: no page covers migration from JSF, so the page doesn't mention it.
  • Vale: no alerts. On main, the page has one warning (the exclamation point in the title) and one suggestion. Vaadin.Versions is turned off around the existing-code list, because Multiplatform Runtime applies only to Vaadin 7 and 8. The Feature Pack and Upgrading pages use the same pattern.
  • I rendered the page body with Asciidoctor to check the lists. I didn't run the full DS Publisher build.

🤖 Generated with Claude Code

The front page sent everyone to the Quick Start and put the evaluation
reading list in one long paragraph. It now has two labeled paths, Learn
and Evaluate, and a section for readers who start from existing code: a
Java application, a REST API or separate backend, a Swing application,
or an older Vaadin version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@peholmst peholmst added the target/v25.3 Automatically cherry-pick to the v25.3 branch label Oct 23, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Preview Deployment

This PR has been deployed for preview.

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

Changed pages

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

Built from b376bbf

@peholmst
peholmst merged commit 322d191 into main Oct 23, 2026
11 checks passed
@peholmst
peholmst deleted the claude/gallant-moore-c98785 branch October 23, 2026 12:59
peholmst added a commit that referenced this pull request Oct 23, 2026
…6482) (CP: v25.3) (#6483)

Co-authored-by: Petter Holmström <petter@vaadin.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cherry-picked-v25.3 target/v25.3 Automatically cherry-pick to the v25.3 branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants