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

Make it very obvious where Getting Started with Security tutorial is #36353

Merged
merged 2 commits into from
Oct 20, 2023

Conversation

sberyozkin
Copy link
Member

@sberyozkin sberyozkin commented Oct 9, 2023

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 that Secure a Quarkus Application with Basic Authentication and Jakarta Persistence tutorial is in a Getting Started category, that it is meant to be seen as a Getting 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:

  • Highlight in the doc title and preamble that it is primarily about 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)
  • Renamed security-basic-authentication-tutorial.adoc to security-getting-started-tutorial.adoc - not critical but I think having an https://quarkus.io/guides/security-getting-started-tutorial link to represent a Getting Started tutorial should increase its visibility.

CC-ing to Michelle and Michal who helped with the initial text improvements related to this tutorial

@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Oct 9, 2023
@quarkus-bot quarkus-bot bot added this to To do in Quarkus Documentation Oct 9, 2023
@sberyozkin sberyozkin force-pushed the security_getting_started_doc branch 2 times, most recently from e0fd989 to 49a2c73 Compare October 9, 2023 12:41
@rsvoboda
Copy link
Member

re-triggered docs build which was aborted after 6 hours

@sberyozkin
Copy link
Member Author

Thanks @rsvoboda - but see #36349, it is a problem with most PRs affecting docs (those which have been mirrored in the product docs)

@rsvoboda
Copy link
Member

@sberyozkin pls rebase, #36384 was merged

@github-actions
Copy link

github-actions bot commented Oct 10, 2023

🙈 The PR is closed and the preview is expired.

Copy link
Member

@rsvoboda rsvoboda left a 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

Quarkus Documentation automation moved this from To do to Review pending Oct 10, 2023
@quarkus-bot quarkus-bot bot added the area/infra-automation anything related to CI, bots, etc. that are used to automated our infrastructure label Oct 10, 2023
@quarkus-bot

This comment has been minimized.

@sberyozkin
Copy link
Member Author

@rsvoboda This PR has indeed been fixed, thanks (#35897 still fails).
Please review again,
But I'd like to wait for the Doc team to comment as well

@sberyozkin
Copy link
Member Author

@rsvoboda 3.5.0 is due tomorrow, so if you'd like this change to make it to 3.5.0 then please approve.
https://quarkus-pr-main-36353-preview.surge.sh/version/main/guides/ (Category: Security) looks good to me now with respect to this guide.

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

@quarkus-bot
Copy link

quarkus-bot bot commented Oct 17, 2023

Failing Jobs - Building 0571e14

Status Name Step Failures Logs Raw logs Build scan
JVM Tests - JDK 11 Build ⚠️ Check → Logs Raw logs
JVM Tests - JDK 17 Build ⚠️ Check → Logs Raw logs
JVM Tests - JDK 17 Windows Build Failures Logs Raw logs
🚫 JVM Tests - JDK 20
✔️ Maven Tests - JDK 11
Maven Tests - JDK 11 Windows Build Failures Logs Raw logs

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

io.quarkus.vertx.http.proxy.TrustedForwarderProxyFailureTest.testHeadersAreIgnored line 29 - More details - Source on GitHub

java.net.SocketTimeoutException: Read timed out
	at java.base/sun.nio.ch.NioSocketImpl.timedRead(NioSocketImpl.java:288)
	at java.base/sun.nio.ch.NioSocketImpl.implRead(NioSocketImpl.java:314)

⚙️ Maven Tests - JDK 11 Windows #

- Failing: integration-tests/maven 

📦 integration-tests/maven

io.quarkus.maven.it.DevMojoIT.testExternalReloadableArtifacts line 1448 - More details - Source on GitHub

org.awaitility.core.ConditionTimeoutException: Condition with lambda expression in io.quarkus.maven.it.DevMojoIT was not fulfilled within 1 minutes.
	at org.awaitility.core.ConditionAwaiter.await(ConditionAwaiter.java:167)
	at org.awaitility.core.CallableCondition.await(CallableCondition.java:78)

io.quarkus.maven.it.JarRunnerIT.testNonAsciiDir line 70 - More details - Source on GitHub

java.lang.AssertionError: 

Expecting actual:

io.quarkus.maven.it.DevMojoIT.testExternalReloadableArtifacts line 1448 - More details - Source on GitHub

org.awaitility.core.ConditionTimeoutException: Condition with lambda expression in io.quarkus.maven.it.DevMojoIT was not fulfilled within 1 minutes.
	at org.awaitility.core.ConditionAwaiter.await(ConditionAwaiter.java:167)
	at org.awaitility.core.CallableCondition.await(CallableCondition.java:78)

io.quarkus.maven.it.JarRunnerIT.testNonAsciiDir line 70 - More details - Source on GitHub

java.lang.AssertionError: 

Expecting actual:

Copy link
Member

@rsvoboda rsvoboda left a 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.

Quarkus Documentation automation moved this from Review pending to Reviewer approved Oct 18, 2023
@rsvoboda
Copy link
Member

@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.

@sberyozkin
Copy link
Member Author

Thanks @rsvoboda, and yes, we will work with the Doc team to tune things as always

@sberyozkin sberyozkin merged commit 997cab3 into quarkusio:main Oct 20, 2023
52 of 56 checks passed
Quarkus Documentation automation moved this from Reviewer approved to Done Oct 20, 2023
@sberyozkin sberyozkin deleted the security_getting_started_doc branch October 20, 2023 09:47
@quarkus-bot quarkus-bot bot added this to the 3.6 - main milestone Oct 20, 2023
@sberyozkin
Copy link
Member Author

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docstyle issues related for manual docstyle review area/documentation area/infra-automation anything related to CI, bots, etc. that are used to automated our infrastructure
Development

Successfully merging this pull request may close these issues.

None yet

2 participants