spring-projects / spring-projects/spring-boot
Move tools javadoc to a different module
Open
Nobody has claimed this yet.
status: pending-design-work
status: team-only
type: documentation
- Dominant language
- Java
- Stars
- 81.5k
- Forks
- 42.7k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 65
Description
Currently our tools API docs are mixed with our regular API docs.
.findAll { !it.path.contains(":spring-boot-tools:") ||
it.path.contains(":spring-boot-tools:spring-boot-buildpack-platform") ||
it.path.contains(":spring-boot-tools:spring-boot-loader-tools") }
It might be better to have a /tools/api/java path rather than mixing with /api/java.
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 locating the build or documentation configuration containing the shown path filter and inspect how Javadoc output paths are assembled. Update the configuration so tools API docs use /tools/api/java instead of being mixed with /api/java, then verify the generated paths and existing exclusions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100