spring-cloud-kubernetes icon indicating copy to clipboard operation
spring-cloud-kubernetes copied to clipboard

Missing descriptions in configprops.adoc

Open HJK181 opened this issue 3 years ago • 4 comments

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

HJK181 avatar Apr 19 '23 09:04 HJK181

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 avatar Apr 19 '23 09:04 wind57

@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...

wind57 avatar Apr 21 '23 06:04 wind57

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.

ryanjbaxter avatar Apr 21 '23 15:04 ryanjbaxter

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

wind57 avatar Apr 21 '23 16:04 wind57