Update Documentation to point to spring-security-samples #9826
Conversation
spring-projects-issues
added
the
status: waiting-for-triage
marcusdacoregio
force-pushed
the
gh-9784
branch
9 times, most recently
from
21ae8d3 to
60f2da4
Compare
marcusdacoregio
force-pushed
the
gh-9784
branch
2 times, most recently
from
e6e7d20 to
9d0aa38
Compare
marcusdacoregio
added
in: docs
marcusdacoregio
force-pushed
the
gh-9784
branch
2 times, most recently
from
2362d96 to
1412a2e
Compare
There was a problem hiding this comment.
Thanks, @marcusdacoregio! I've left some initial feedback inline.
docs/guides/src/docs/asciidoc/_includes/setting-up-the-sample-boot.asc
Outdated
Show resolved
Hide resolved
docs/guides/src/docs/asciidoc/_includes/setting-up-the-sample-boot.asc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/about/exploits/http.adoc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/servlet/authentication/jaas.adoc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/servlet/authentication/x509.adoc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/servlet/exploits/csrf.adoc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/servlet/hello/index.adoc
Outdated
Show resolved
Hide resolved
marcusdacoregio
force-pushed
the
gh-9784
branch
5 times, most recently
from
54cb855 to
c07a0a3
Compare
There was a problem hiding this comment.
Thanks for the updates, @marcusdacoregio. I've noted a few more items inline. Please also double-check the list from the last review -- sometimes GitHub will collapse review items, making them easy to miss.
docs/guides/src/docs/asciidoc/_includes/setting-up-the-sample-boot.asc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/servlet/authentication/preauth.adoc
Outdated
Show resolved
Hide resolved
marcusdacoregio
force-pushed
the
gh-9784
branch
3 times, most recently
from
5b6fbc4 to
7d6854f
Compare
| @@ -51,7 +51,7 @@ If you have more than one in your application context, you need to specify which | |||
|
|
|||
| [[remember-me-persistent-token]] | |||
| === Persistent Token Approach | |||
| This approach is based on the article http://jaspan.com/improved_persistent_login_cookie_best_practice[http://jaspan.com/improved_persistent_login_cookie_best_practice] with some minor modifications footnote:[Essentially, the username is not included in the cookie, to prevent exposing a valid login name unecessarily. | |||
| This approach is based on the article https://web.archive.org/web/20180819014446/http://jaspan.com/improved_persistent_login_cookie_best_practice[http://jaspan.com/improved_persistent_login_cookie_best_practice] with some minor modifications footnote:[Essentially, the username is not included in the cookie, to prevent exposing a valid login name unecessarily. | |||
There was a problem hiding this comment.
This link should be updated in the PersistentTokenBasedRememberMeServices class' javadoc
There was a problem hiding this comment.
It might be worth while to document the algorithm implemented by spring security in the docs, rather than pointing to web.archive.org as that link might disappear at some point in the future.
There was a problem hiding this comment.
@asaikali This is a good suggestion, but I think in this PR we should stick to fixing the broken links. Could you please open an issue specifically to document it in the docs instead of point out to the web.archive.org domain?
There was a problem hiding this comment.
Looking good, @marcusdacoregio. I've left some additional feedback inline.
docs/guides/src/docs/asciidoc/_includes/setting-up-the-sample-boot.asc
Outdated
Show resolved
Hide resolved
marcusdacoregio
force-pushed
the
gh-9784
branch
4 times, most recently
from
740d67e to
8aaa31f
Compare
|
@jzheaux could you please review the PR? I've done some changes based on your comments. Thank you. |
Update the docs to point to the new Spring Security Samples project.
Fix some broken links not related to the samples as well.
Add a link checker that can be used by running the
htmlSanityCheckgradle taskCloses gh-9815, gh-9816, gh-9817, gh-9818, gh-9869