spring-projects / spring-projects/spring-boot
Formatting and links in configuration properties metadata
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 81.5k
- Forks
- 42.7k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 65
Description
Configuration properties metadata is intentionally minimally formatted. This causes problems and confusion for library authors because they want to write normal javadocs. I don't know if there's anything that can be done about that, but maybe we can do something simpler that would help. Perhaps a new feature to link to some more documentation (URLs could be automatically converted to links by IDEs for instance)? That way the javadocs and the JSON could stay terse, but users would be able to find more documentation quickly, as long as it was supported in the IDEs.
See #10930
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 configuration properties metadata behavior described in this issue and the related issue #10930. Determine whether metadata can support links without changing the terse documentation format, which IDEs would need to consume them, and what supported behavior would constitute completion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100