Skip to content

[Security] Idea for restructuring the docs #13413

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

Closed
ThomasLandauer opened this issue Mar 24, 2020 · 2 comments
Closed

[Security] Idea for restructuring the docs #13413

ThomasLandauer opened this issue Mar 24, 2020 · 2 comments
Labels

Comments

@ThomasLandauer
Copy link
Contributor

Here's an idea to restructure https://symfony.com/doc/current/security.html completely - sort of a follow-up of #11505

  • Start with a minimal security.yaml, then explain the options for the three main components:
  • User
  • Login: Guard or Controller. Voters or Roles or Controller.
  • Routes: security.yaml or Controller

For each of these, explain which approaches are available and what pros and cons they have. Always start with a minimal approach (i.e. doing it "manually" in the controller), then show the advantages of professionalizing it.

@javiereguiluz
Copy link
Member

Hi. Thanks for your proposal Thomas. We appreciate your dedication to help us improve the docs.

However, the security docs are a bit special. They are extremely critical (any mistake in the docs can make your app vulnerable), extremely important and extremely complex to write. That's why we're working on them privately in the Symfony Docs team. Our friend @wouterj is working together with @weaverryan in a complete revamp of the Security code and features. Once that is finished, we'll discuss internally in the Symfony Docs team how to proceed with the total revamp of the Security docs.

We'll take into account your comments (and others added in the past by other community members) ... but meanwhile we're going to close this to not open the public discussion about this yet. Thanks for understanding ... and thanks again for all your help!!!

@ThomasLandauer
Copy link
Contributor Author

@wouterj @weaverryan I just created a gist for a "magic link" login system, which (I think) should be covered in the new docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants