spring-projects / spring-projects/spring-security
Copy-paste error in documentation.
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
Describe the bug
Under Spring Security - Project Modules and Dependencies documentation [1], the text appears to be incorrect, and (for the most part) a copy of [2]. In particular the following text appears to have been copied without updating it to reflect client scope of usage and package.
It is required by applications that use OAuth 2.0 or OpenID Connect Core 1.0, such as the client, the resource server, and the authorization server. The top-level package is
org.springframework.security.oauth2.core.
[1] https://docs.spring.io/spring-security/reference/modules.html#spring-security-oauth2-client
[2] https://docs.spring.io/spring-security/reference/modules.html#spring-security-oauth2-core
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
Open the Project Modules and Dependencies documentation at the linked spring-security/reference/modules.html sections for OAuth2 Client and OAuth2 Core, then compare their wording and package references. Update the client section so it describes client usage accurately rather than copying the core section, and verify the two sections remain distinct.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100