spring-projects / spring-projects/spring-security
Publish Reference PDF and Single HTML
Open
Nobody has claimed this yet.
status: waiting-for-triage
type: enhancement
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
It would be great to have the PDFs and single HTML pages back again, so the docs can be read like a book.
I personally find the single HTML without JavaScript - the version seen last in 5.5.8 - the easiest and quickest to use on desktop. It can easily be printed to PDF too.
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 Spring Security documentation build and publication configuration, then compare the current outputs with the 5.5.8 reference/html5 example linked in the issue. Done means the documentation publishes both a reference PDF and a single HTML page that can be read without JavaScript.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100