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

Remove duplicated Spring Boot configuration properties documentation #4982

Open
shakuzen opened this issue Apr 22, 2024 · 0 comments
Open

Remove duplicated Spring Boot configuration properties documentation #4982

shakuzen opened this issue Apr 22, 2024 · 0 comments
Labels
doc-update A documentation update help wanted An issue that a contributor can help us with
Milestone

Comments

@shakuzen
Copy link
Member

See, for example, #4851 which is addressing the Micrometer documentation for our Influx registry implementation getting out of sync with the corresponding support in Spring Boot. While it may be convenient to see at a glance what configuration options are available by duplicating the Spring Boot configuration properties, it has problems like this becoming out of sync. Micrometer does not depend on Spring or Spring Boot, so we shouldn't be documenting its support (that is available in the Spring Boot documentation) like this.

That said, we don't want users to be completely unable to figure out what's configurable for a Micrometer registry implementation. I think a compromise we can take for now is linking to the JavaDoc site of the Config class for the registry. The JavaDoc for that class will contain all the methods and descriptions for them.

A perhaps nicer solution would be to generate a table that goes in the documentation with information like Config method name, description, default value.

@shakuzen shakuzen added help wanted An issue that a contributor can help us with doc-update A documentation update labels Apr 22, 2024
@shakuzen shakuzen added this to the 1.12.x milestone Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-update A documentation update help wanted An issue that a contributor can help us with
Projects
None yet
Development

No branches or pull requests

1 participant