spring-projects / spring-projects/spring-security
SEC-2720: Documentation Has Broken Links
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
Frank Beerstein (Migrated from SEC-2720) said:
Can you please create a new catch-all project called Spring.io Web Site? I have found a dozen broken links to various documentation, and in some cases, as in this case, there is no listed Project in your JIRA (could not find a project for Spring Cloud).
This is a major issue for anyone trying to learn your platform. In this case, on the listed page, half of the example apps are 404s.
As webmaster and architect, might I suggest you run a link checker on your site every evening, and have your test team notified? There's no excuse for having even a single broken link, given today's plethora of tools for detecting them.
If you do not do that, can you please put a prominent link on the footer of your pages to report broken web pages on your site?
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
The issue names no repository file, test, or entry point. Start by locating the page with the reported example-app links and confirming the 404s; the requested scope remains unresolved between fixing links, adding a reporting footer, and setting up recurring link checks.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100