spring-projects / spring-projects/spring-security

SEC-2337: ACL documentation refers to non-existent samples

Open
#2,561 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

in: docs type: bug type: jira
Dominant language
Java
Stars
9.6k
Forks
6.3k
Avg merge
2d 11h
Merged PRs (30d)
52

Description

Nick Williams (Migrated from SEC-2337) said:

The reference documentation for access control lists says the following:

Refer to one of the samples that ship with Spring Security for an example configuration

and

refer to the ACL samples for the appropriate SQL statements

However, no ACL sample is listed in https://github.com/spring-projects/spring-security/tree/master/samples. Either no samples actually exist (in which case the documentation needs sample configurations or a sample should be created), or the sample ACL config is buried in some other sample (in which case the documentation should be updated to link to the specific sample or samples that should be referenced). A Spring Security user less knowledgable about the source code would have some difficulty deriving the correct configuration.

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 the ACL reference documentation at the linked Spring Security 3.2.x page and inspect the repository's samples directory. Determine whether ACL configuration exists in another sample or is absent; done means the documentation points to a real sample or provides the needed configuration and SQL guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
documentation, security
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.