Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing descriptions in configprops.adoc #1311

Open
HJK181 opened this issue Apr 19, 2023 · 4 comments
Open

Missing descriptions in configprops.adoc #1311

HJK181 opened this issue Apr 19, 2023 · 4 comments

Comments

@HJK181
Copy link

HJK181 commented Apr 19, 2023

Is your feature request related to a problem? Please describe.
_configprops.adoc is missing a description for many entries.

Describe the solution you'd like
_configprops.adoc entries must all contain a useful description and in best case also an example.

Describe alternatives you've considered
Shimmy through the code to find out how to configure a property, specifically spring.cloud.kubernetes.discovery.filter

@wind57
Copy link
Contributor

wind57 commented Apr 19, 2023

We already have such an issue to work on, see here. It will take a little bit of work for us to align our internal code fully, and then I'll work on documenting everything properly.

As such, to me, this is a duplicate.

@wind57
Copy link
Contributor

wind57 commented Apr 21, 2023

@ryanjbaxter to me, this is a duplicate and can be closed. I will get my hands on this issues with documentation after I align fabric and k8s clients...

@ryanjbaxter
Copy link
Contributor

configprops.adoc is generated based on the additional-spring-configuration-metadata.json files. We need to update them to be in sync with the properties we use. I believe there is a tool someone wrote on the Spring team that will generate this or at least identify missing properties (as long as they are defined in @ConfigurationProperties). I will have to see if I can dig that up.

To me this is a separate issue than #1237.

@wind57
Copy link
Contributor

wind57 commented Apr 21, 2023

I see, I took a closer look and yeah, you right. thank you and sorry for the noise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants