Kubernetes Kit inspected packages during serialization documentation is incorrect

Open Beginner friendly
#3,308 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
java, kubernetes
Domain
documentation

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.

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.

Dominant language
AsciiDoc
Stars
38
Forks
225
Avg merge
1d 4h
Merged PRs (30d)
170

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.

More from vaadin/docs

All issues in vaadin/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.