spring-projects / spring-projects/spring-security
Many broken URLs in the documentation pointing to spring reference with #hash part
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
For example here there are several links referencing to spring reference documentation:
-
broker prefix which is correctly redirects to new location but losing
hashpart if the URL in the process. The correct new URL should be: https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#websocket-stomp -
Flow of Messages redirects to new location, but should redirect here (note the
hashpart).
Initially I wanted to just fix these URLs at least in webscoket docs and create a pull request, but then I began to have doubts: maybe there is some mechanism already to bulk-update all URLs from old to new locations? Or maybe you want to make this update centralized and don't want to accept a bunch of pull requests from different people fixing these broken URLs here and there...
Let me know if I should make a PR to fix at least some URLs or you consider another approach (some script?) to fix this all at once.
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 docs/manual/src/docs/asciidoc/_includes/servlet/integrations/websocket.adoc and inspect the documented links to the Spring reference. Determine whether the broken hash links are isolated or require a bulk update across the documentation, then verify that corrected URLs retain their section anchors.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100