Commit 3d0eb51
committed
feature #15503 [Security] Rewrite Security documentation (wouterj, weaverryan)
This PR was merged into the 5.3 branch.
Discussion
----------
[Security] Rewrite Security documentation
This is still very WIP, but I wanted to get it out here to receive the first set of global feedback (I haven't re-read anything, so no need to comment on typos, wrong sentences or grammar yet).
Of course, the main goal of this rewrite is to document the new authenticator system and remove anything about guards, authentication providers, etc. Besides that, I've focused on 3 other things:
1. **Give the user something that's working as quick as possible.** This means using lots of makers and showing real code examples. I've discussed with Ryan and Jesse and we'll also extend the security makers to make even more docs redundant (I'm jealous at Laravel, which basically replaced all its authentication docs with "run `jetstream:install`").
2. **Move as much information to the main guide as possible** (following our doc practices of the last years). This means e.g. documenting all user providers and authenticators in the main guide. The subguides should be clearly scoped and about advanced/reference documentation (most of the subguides are yet to be worked on)
3. **Focus on the built-in authenticators, rather than implementing your own authenticator.** We've pushed writing your own guard in the docs way to much for my liking. E.g. for 90% of the use-cases, using the built-in `form_login` authenticator works perfectly. This will also be updated in the maker (where `make:auth` is not only going to suggest making a PHP authenticator) sometime in the future.
For the structure, I decided to follow the security config generated by the recipe/maker and explain section per section.
Commits
-------
cc84098 Fixes after final review from Javier and Ryan
1e49d52 fixing syntax error
df05fdb Various tweaks to the new security documentation
d5460ed Rewrite Security documentationFile tree
32 files changed
+3875
-5193
lines changed- _build
- _images
- security
- sources/security
- doctrine
- reference/configuration
- security
32 files changed
+3875
-5193
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
121 | 121 | | |
122 | 122 | | |
123 | 123 | | |
124 | | - | |
125 | | - | |
126 | | - | |
127 | | - | |
128 | | - | |
129 | | - | |
130 | | - | |
131 | | - | |
132 | | - | |
133 | | - | |
134 | | - | |
135 | 124 | | |
136 | 125 | | |
137 | 126 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
518 | 518 | | |
519 | 519 | | |
520 | 520 | | |
521 | | - | |
| 521 | + | |
| 522 | + | |
| 523 | + | |
| 524 | + | |
| 525 | + | |
| 526 | + | |
| 527 | + | |
| 528 | + | |
| 529 | + | |
| 530 | + | |
| 531 | + | |
| 532 | + | |
| 533 | + | |
| 534 | + | |
Loading
Loading
Binary file not shown.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
335 | 335 | | |
336 | 336 | | |
337 | 337 | | |
338 | | - | |
339 | | - | |
340 | | - | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
341 | 341 | | |
342 | 342 | | |
343 | 343 | | |
| |||
0 commit comments