spring-projects / spring-projects/spring-security
Avoid broken links caused by htmlsingle to html5 directory name change
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
With thanks to @dreis2211 for bringing it to my attention, the change from htmlsingle to html5 in Spring Security 5.3 has broken some documentation links. It'd be nice if existing links to https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/ would continue to work. It'd also be nice if you could take any 5.2.x link and change it to 5.3.x and not get a 404.
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 comparing the documented Spring Security 5.2.x and 5.3.x URL patterns, especially the htmlsingle and html5 paths cited in the issue. Done means existing htmlsingle links continue to resolve and changing a 5.2.x link to 5.3.x does not produce a 404.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100