spring-projects / spring-projects/spring-boot
Provide configuration properties documentation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 81.5k
- Forks
- 42.7k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 65
Description
We currently link to source code for configuration properties info. E.g
For more detail, see the {spring-boot-actuator-autoconfigure-module-code}/web/server/ManagementServerProperties.java[`ManagementServerProperties`] source code and "`xref:ROOT:actuator/monitoring.adoc#actuator.monitoring.customizing-management-server-port[Customizing the Management Server Port]`" in the "`Production-ready features`" section.
We could link to javadoc, but because we use field javadoc it's not that useful. Perhaps we can generate a new type of api documentation based on the configuration json metadata instead. This could also replace https://docs.spring.io/spring-boot/docs/3.2.x/reference/htmlsingle/#appendix.application-properties.actuator
This might also allow configprop:...[] to become links.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the referenced ManagementServerProperties.java source and the existing configuration JSON metadata. Compare those with the current application-properties appendix, including the actuator section, to understand what documentation exists today. Done should mean configuration properties have generated documentation and the relevant configprop references can link to it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100