vaadin / vaadin/spring

Servlet parameter documentation for Spring + Flow

Open
#353 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Java
Stars
186
Forks
98
PR merge metrics
No merged PRs in 30d

Description

There are some Vaadin-specific servlet parameters (heartBeatInterval, closeIdleSessions etc.) that need to be configured for different environments from time to time. The existence of those parameters is documented here: https://vaadin.com/docs/v10/flow/advanced/tutorial-application-lifecycle.html and https://vaadin.com/docs/v10/flow/spring/tutorial-spring-configuration.html mentions "There are a number of properties that you can use to configure your Flow application. See e.g. com.vaadin.server.DeploymentConfiguration and com.vaadin.server.Constants classes for property names.", but the documentation lacks proper usage examples.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Flow application lifecycle and Spring configuration documentation, especially the section referencing DeploymentConfiguration and Constants. Add usage examples showing how servlet parameters such as heartBeatInterval and closeIdleSessions are configured for different environments, and verify that the examples clearly explain the property names and placement.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.