Kubernetes Kit inspected packages during serialization documentation is incorrect
Nobody has claimed this yet.
- Dominant language
- AsciiDoc
- Stars
- 38
- Forks
- 225
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 170
Description
The documentation for the Kubernetes Kit package inspection during serialization is wrong. Both properties are missing an additional "transients" part.
Currently, the example looks like this:
vaadin.serialization.include-packages=com.example.application
vaadin.serialization.exclude-packages=com.example.application.service
And the correct properties are:
vaadin.serialization.transients.include-packages=com.example.application
vaadin.serialization.transients.exclude-packages=com.example.application.service
See NestedConfigurationProperty here: https://github.com/vaadin/kubernetes-kit/blob/main/kubernetes-kit-starter/src/main/java/com/vaadin/kubernetes/starter/SerializationProperties.java#L37
If you think this issue is important, add a 👍 reaction to help the community and maintainers prioritize this issue.
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
Locate the Kubernetes Kit documentation example for serialization package inspection and compare it with kubernetes-kit-starter/src/main/java/com/vaadin/kubernetes/starter/SerializationProperties.java, especially the NestedConfigurationProperty at line 37. Update both example properties to include the transients segment, then verify that the documentation matches the source configuration names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100