spring-projects / spring-projects/spring-security
docs zip does not contain reference html files (5.7.3)
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
Describe the bug
README.adoc says that "./gradlew build" will build docs, but it builds only api docs. I could not find a way to build reference locally.
To Reproduce
./gradlew build
Expected behavior
docs/build/distributions/spring-security-5.7.3-docs.zip contains reference htmls
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 with README.adoc and run ./gradlew build, then inspect docs/build/distributions/spring-security-5.7.3-docs.zip to compare its contents with the expected reference HTML files. Trace the documentation build and packaging configuration that the command invokes. Done means the generated docs zip contains the reference HTML files as well as the API docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100