Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ACL docs refer to nonexistent sample apps #10110

Closed
sgrimm opened this issue Jul 16, 2021 · 3 comments
Closed

ACL docs refer to nonexistent sample apps #10110

sgrimm opened this issue Jul 16, 2021 · 3 comments
Assignees
Labels
in: docs An issue in Documentation or samples status: backported An issue that has been backported to maintenance branches type: bug A general bug

Comments

@sgrimm
Copy link

sgrimm commented Jul 16, 2021

The ACL docs say:

You’ll also need to populate the database with the four ACL-specific tables listed in the last section (refer to the ACL samples for the appropriate SQL statements).

The samples are described in the previous section of the docs as:

Two samples ship with Spring Security that demonstrate the ACL module. The first is the Contacts Sample, and the other is the Document Management System (DMS) Sample.

But neither of those samples exists in the spring-security-samples repo, and none of the existing samples seem to refer to the ACL tables.

EDIT: Originally I thought this meant the schemas were undocumented, but I see they're documented in an appendix. The main part of the docs should probably point to the appendix instead of the samples.

@sgrimm sgrimm added status: waiting-for-triage An issue we've not yet triaged type: bug A general bug labels Jul 16, 2021
@sgrimm sgrimm changed the title ACL docs refer to nonexistent sample apps, causing database schema to be undocumented ACL docs refer to nonexistent sample apps Jul 16, 2021
@jzheaux
Copy link
Contributor

jzheaux commented Jul 19, 2021

Thanks for bringing this up, @sgrimm. The documentation is referring to the contacts and dms samples that have not yet been migrated from Spring Security into spring-security-samples.

I think it would be helpful to do two things:

  1. Update the existing documentation to point to the 5.4.x samples - we are already doing this with some yet-to-be-migrated samples.
  2. Add a ticket to spring-security-samples to get the samples migrated.

Are you able to submit a PR that updates the docs and then also add a ticket to do the migration?

@jzheaux jzheaux added in: docs An issue in Documentation or samples and removed status: waiting-for-triage An issue we've not yet triaged labels Jul 19, 2021
@marcusdacoregio
Copy link
Contributor

Thanks @jzheaux and @sgrimm.

I've updated an already created ticket to include those two ACL samples.

marcusdacoregio added a commit that referenced this issue Sep 6, 2021
@spring-projects-issues spring-projects-issues added the status: backported An issue that has been backported to maintenance branches label Sep 6, 2021
@marcusdacoregio
Copy link
Contributor

Thanks @sgrimm. The two samples are now migrated to the new samples repository and I have updated the documentation to point to those samples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: docs An issue in Documentation or samples status: backported An issue that has been backported to maintenance branches type: bug A general bug
Projects
None yet
Development

No branches or pull requests

4 participants