spring-projects / spring-projects/spring-security

Many broken URLs in the documentation pointing to spring reference with #hash part

Open
#6,726 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

in: docs status: feedback-provided
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:

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.