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.

Sign up for GitHub

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

Jump to bottom

Doc link fixes & enhancements to Bearer token authentication tutorial #35849

Merged
merged 1 commit into from
Sep 15, 2023
Merged

Doc link fixes & enhancements to Bearer token authentication tutorial #35849

merged 1 commit into from
Sep 15, 2023

Conversation

michelle-purcell
Copy link
Contributor

@michelle-purcell michelle-purcell commented Sep 11, 2023 •
edited
Loading

This PR fixes links, some grammar, and section numbering as per the preferred Quarkus Contributor guidelines for writing tutorials.
This also makes the content more harmonious with product docs downstream for the 3.2 release.

@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Sep 11, 2023
@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-product branch from b020626 to b0dbd6b Compare September 11, 2023 14:06
@quarkus-bot quarkus-bot bot added area/dependencies Pull requests that update a dependency file area/resteasy-classic area/rest labels Sep 11, 2023
@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-product branch from b0dbd6b to 45f3d57 Compare September 11, 2023 14:07
@michelle-purcell michelle-purcell changed the title DRAFT - Doc link fixes & enhancements to Bearer token authentication tutorial Doc link fixes & enhancements to Bearer token authentication tutorial Sep 11, 2023
@quarkus-bot

This comment has been minimized.

Sign in to view
@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-product branch from 45f3d57 to d9c815c Compare September 11, 2023 18:13
@michelle-purcell
Copy link
Contributor Author

@gastaldi / @gsmet - I'm not seeing the doc site preview yet in this PR. The sad and empty wine glass emoji doesn't even display 🍷 Is it still poorly? Thanks

@michelle-purcell
Copy link
Contributor Author

@sberyozkin - Please can you review the updates here 🙏

I made some style and grammar enhancements after running the product doc prep style checker and final PV2 preview check. I hope these don't alter technical meaning but add clarity, some accessibility, and localization benefits.
I remember making these before but I think they got wiped out somehow during conflict resolution 😕

I also added the (harmonious) section numbering approach and patch for our PV2 system, which was recently tried and tested with the basic auth tutorial.

If you spot anything here that isn't applicable to 3.2, please let me know. Thanks :-)

@gastaldi
Copy link
Contributor

@michelle-purcell that's because our CI is still busy, you should hopefully see it when the job completes 😀

@MichalMaler MichalMaler self-requested a review September 12, 2023 07:43
@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-product branch from d9c815c to 504e6c5 Compare September 12, 2023 10:50
@sberyozkin
Copy link
Member

Thanks @michelle-purcell, looks nice, I only have a question about devmode vs developer mode, my understanding devmode is preferred but lets wait for some comments, thanks

@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-product branch from 4bd97f2 to 94c891c Compare September 12, 2023 12:57
@quarkus-bot quarkus-bot bot added area/arc Issue related to ARC (dependency injection) area/config area/core area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/gradle Gradle area/platform Issues related to definition and interaction with Quarkus Platform area/spring Issues relating to the Spring integration labels Sep 12, 2023
@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-product branch from 94c891c to e0ce113 Compare September 12, 2023 13:10
MichalMaler
MichalMaler approved these changes Sep 12, 2023
View reviewed changes
Copy link
Contributor

@MichalMaler MichalMaler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, @michelle-purcell Here are just some minor suggestions. Apply if you like them. The rest is good. Approving! :)
Cheers!

docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc Show resolved Hide resolved
docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc Outdated Show resolved Hide resolved
@michelle-purcell
Copy link
Contributor Author

@MichalMaler - Thanks so much for your review and comments. I applied most. One changes the technical meaning as per comment ^^ so I'd like to get wider input.
Thanks 💚

@michelle-purcell
Copy link
Contributor Author

@gastaldi / @gsmet - Any ideas why the doc build is failing in this and other PRs today?

I'm seeing several errors like these in my PR and some others too.

image
Thanks

@github-actions
Copy link

github-actions bot commented Sep 13, 2023 •
edited
Loading

🙈 The PR is closed and the preview is expired.

@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-product branch from 1a40178 to fa26cb5 Compare September 14, 2023 10:09
@michelle-purcell
Copy link
Contributor Author

michelle-purcell commented Sep 14, 2023 •
edited
Loading

@gastaldi / @sberyozkin - As we have approval from 3 folks, could we please merge this PR before it becomes stale and in conflict with other PRs? Thanks 🙏

@gastaldi
Copy link
Contributor

@michelle-purcell can you please squash all commits before we merge it?

@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-product branch 2 times, most recently from 60cc422 to 4dd6802 Compare September 15, 2023 15:50
@michelle-purcell
Copy link
Contributor Author

@gastaldi - Sorry forgot to do that! It's done now. Thanks 👍

@gastaldi gastaldi merged commit 82344e7 into quarkusio:main Sep 15, 2023
4 of 5 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.5 - main milestone Sep 15, 2023
@michelle-purcell @MichalMaler
Doc link fixes & enhancements to Bearer token authentication tutorial
4dd6802 
code fix

Minor tweak

Revert back dev mode but call our development on first instance

Update docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc

Co-authored-by: Mickey Maler <[email protected]>

Update docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc

Co-authored-by: Mickey Maler <[email protected]>

Update docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc

Co-authored-by: Mickey Maler <[email protected]>

Update docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc

Co-authored-by: Mickey Maler <[email protected]>

Update docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc

Co-authored-by: Mickey Maler <[email protected]>
@michelle-purcell
Copy link
Contributor Author

@gastaldi 🦸 Thank you.

@gsmet gsmet modified the milestones: 3.5 - main, 3.2.7.Final Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MichalMaler MichalMaler MichalMaler approved these changes

@gastaldi gastaldi gastaldi left review comments

@geoand geoand geoand approved these changes

@sberyozkin sberyozkin sberyozkin approved these changes

Assignees
No one assigned
Labels
area/arc Issue related to ARC (dependency injection) area/config area/core area/dependencies Pull requests that update a dependency file area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/docstyle issues related for manual docstyle review area/documentation area/gradle Gradle area/platform Issues related to definition and interaction with Quarkus Platform area/rest area/resteasy-classic area/spring Issues relating to the Spring integration
Projects
Quarkus Documentation
Status: Done
Milestone
3.2.7.Final
Development

Successfully merging this pull request may close these issues.
6 participants
@michelle-purcell @gastaldi @sberyozkin @geoand @MichalMaler @gsmet