Add documentation for vaadin properties
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 186
- Forks
- 98
- PR merge metrics
- No merged PRs in 30d
Description
This add-on should add documentation for vaadin properties that are not bound to a @ConfigurationProperties bean to provide IDE Assistance.
Here is the result before the changes.
- vaadin.compatibility is not found and IntelliJ adds a warning
- no IDE Assistance
After the changes:
- IntelliJ does not complain anymore
- IDE Assistance: default value and documentation
You can see an example in this PR: https://github.com/vaadin/spring/pull/635
I didn't add all the value documented here: https://vaadin.com/docs/v14/flow/advanced/tutorial-all-vaadin-properties.html
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the example in PR #635 and the Vaadin properties reference linked in the issue. Identify how this add-on exposes Spring configuration metadata for properties not bound to a @ConfigurationProperties bean. Done means the relevant vaadin properties provide IntelliJ assistance, including documentation and default values, without warnings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring, spring-boot
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100