-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
Make it very obvious where Getting Started with Security tutorial is #36353
Make it very obvious where Getting Started with Security tutorial is #36353
Conversation
e0fd989
to
49a2c73
Compare
re-triggered docs build which was aborted after 6 hours |
@sberyozkin pls rebase, #36384 was merged |
49a2c73
to
ef56e50
Compare
🙈 The PR is closed and the preview is expired. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed file need to be adjusted in many places
security-basic-authentication-tutorial
occurences on Quarkus main:
git grep -l security-basic-authentication-tutorial
.github/quarkus-github-bot.yml
docs/downstreamdoc.yaml
docs/src/main/asciidoc/security-authentication-mechanisms.adoc
docs/src/main/asciidoc/security-authorize-web-endpoints-reference.adoc
docs/src/main/asciidoc/security-basic-authentication-howto.adoc
docs/src/main/asciidoc/security-basic-authentication-tutorial.adoc
docs/src/main/asciidoc/security-basic-authentication.adoc
docs/src/main/asciidoc/security-identity-providers.adoc
docs/src/main/asciidoc/security-jpa.adoc
docs/src/main/asciidoc/security-overview.adoc
b264a7f
to
d7760d7
Compare
This comment has been minimized.
This comment has been minimized.
… it is in the Getting Started category
…g-started-tutorial.adoc
d7760d7
to
0571e14
Compare
@rsvoboda 3.5.0 is due tomorrow, so if you'd like this change to make it to 3.5.0 then please approve. If Michelle will have concerns we can follow up with backports to 3.5.1 I guess. Or may be we should keep this PR open until the Doc team gets back. Not sure if we should hurry up or not |
Failing Jobs - Building 0571e14
Full information is available in the Build summary check run. Failures⚙️ JVM Tests - JDK 17 Windows #- Failing: extensions/vertx-http/deployment
! Skipped: devtools/cli extensions/agroal/deployment extensions/amazon-lambda-http/deployment and 364 more 📦 extensions/vertx-http/deployment✖
⚙️ Maven Tests - JDK 11 Windows #- Failing: integration-tests/maven
📦 integration-tests/maven✖
✖
✖
✖
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving, thanks for the update.
@sberyozkin I think this could be merged, this PR is open for more than a week @michelle-purcell @MichalMaler @inoxx03 can comment later if they would appreciate other changes. |
Thanks @rsvoboda, and yes, we will work with the Doc team to tune things as always |
@rsvoboda Not sure if it can be backported now to 3.5.1 ? I suppose we will target 3.6.0 with this, CORS and other updates |
The latest independent review of Quarkus Security guides at https://quarkus.io/guides/ (Choose
Category:Security
) highlighted a problem: even the experienced reviewer could not see thatSecure a Quarkus Application with Basic Authentication and Jakarta Persistence
tutorial is in aGetting Started
category, that it is meant to be seen as aGetting Started with Security
guide, and therefore flagged it as a doc flaw.The only visible indication that it is indeed the Getting Started with Security guide is in https://quarkus.io/guides/security-overview#getting-started-with-quarkus-security, but users looking at https://quarkus.io/guides/ (
Category:Security
) should get an immediate message where it really is.This PR proposes 2 things:
Getting Started with Security
than about combining Basic Authentication and JPA - which are only basic tools in demonstrating how to get started and which have their own dedicated How-To/Concept docs. (Also added a minor clarification in the preamble text about the role of the identity provider)security-basic-authentication-tutorial.adoc
tosecurity-getting-started-tutorial.adoc
- not critical but I think having anhttps://quarkus.io/guides/security-getting-started-tutorial
link to represent aGetting Started
tutorial should increase its visibility.CC-ing to Michelle and Michal who helped with the initial text improvements related to this tutorial