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

Fix missing description for configuration keys in generated appendix #21131

Open
nikmanzotti opened this issue Apr 26, 2020 · 1 comment
Open

Fix missing description for configuration keys in generated appendix #21131

nikmanzotti opened this issue Apr 26, 2020 · 1 comment
Milestone

Comments

@nikmanzotti
Copy link
Contributor

@nikmanzotti nikmanzotti commented Apr 26, 2020

While discussing some documentation improvements (see #21077 and #21121), I've noticed that several common application properties have no description in the current docs dedicated section.
However, all these properties have the descriptive comment, as visible in version 2.1.x docs which was using a different "template" for rendering documentation.

Some properties in this situation are:

  • spring.info.git.location
  • spring.data.rest.detection-strategy
  • spring.datasource.initialization-mode (see screenshots below)
  • spring.elasticsearch.rest.uris
  • spring.mongodb.embedded.features

After a quick look at the 2.1.x doc page, it seems that all the properties have a comment from which the description should be obtained.

This should be further investigated (maybe also checking the Default Value field too), but I have no clue on where to find the code which does this "description extraction". If someone can point me in the right direction, I'll try to have a look.

spring.datasource.initialization-mode - Current doc
image

spring.datasource.initialization-mode - 2.1.x doc
image

@snicoll
Copy link
Member

@snicoll snicoll commented Apr 26, 2020

FTR, that affects only 2.2.x as I can see those properties are correctly documented on master.

@snicoll snicoll added this to the 2.2.x milestone Apr 26, 2020
@snicoll snicoll changed the title Fix missing application properties descriptions in the new documentation "template" Fix missing description for configuration keys in generated appendix Apr 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.