spring-projects / spring-projects/spring-data-commons
Investigate option to toggle imperative/reactive configuration bits in documentation
Open
Nobody has claimed this yet.
in: documentation
type: enhancement
- Dominant language
- Java
- Stars
- 838
- Forks
- 730
- PR merge metrics
- No merged PRs in 30d
Description
For some features (eg. auditing) the actual usage patterns are not that different between the imperative and reactive bits. Still the configuration may differ. So there may be options to reduce duplication and potentially simplify the documentation by having toggles that allow to switch code snippets for those parts.
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
No files, tests, or entry points are named. Review the documentation examples for auditing and compare the imperative and reactive configuration sections; the work is done when a viable toggle approach and its effect on duplicated snippets are established.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100