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

Docs: Final edits, Style enhancements, Vale checks #37888

Merged
merged 1 commit into from Jan 16, 2024

Conversation

sheilamjones
Copy link
Contributor

This PR fixes style issues (title capitalization, one sentence per line...), links, Vale issues, and some grammar as per the preferred Quarkus Contributor guidelines in the security-oidc-bearer-token-authentication.adoc (OpenID Connect (OIDC) Bearer token authentication guide)

@sheilamjones sheilamjones marked this pull request as draft December 21, 2023 14:02
@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Dec 21, 2023
@quarkus-bot quarkus-bot bot added this to To do in Quarkus Documentation Dec 21, 2023
Copy link

github-actions bot commented Dec 21, 2023

🙈 The PR is closed and the preview is expired.

Copy link
Member

@sberyozkin sberyozkin left a comment

Choose a reason for hiding this comment

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

Hi Sheila, it all look nice, once one minor suggestion from me,

enjoy the holidays, thanks

@sheilamjones sheilamjones force-pushed the QDOCS-544-FINALCHECKS branch 2 times, most recently from 6056475 to ffef4d6 Compare January 10, 2024 01:01
@MichalMaler
Copy link
Contributor

MichalMaler commented Jan 10, 2024

@sheilamjones
Hello! Comment I cant apply directly: Missing article
Line 1232:

Authentication that requires a dynamic tenant will fail.

Line 1238:

You can filter OIDC requests made by Quarkus to the OIDC provider by registering one or more `OidcRequestFiler` implementations, which can update or add new request headers and log requests.

@MichalMaler
Copy link
Contributor

@sheilamjones Added some minimalism and grammar-fixing suggestions. Cheers!

@sheilamjones
Copy link
Contributor Author

@sheilamjones Hello! Comment I cant apply directly: Missing article Line 1232:

Authentication that requires a dynamic tenant will fail.

Line 1238:

You can filter OIDC requests made by Quarkus to the OIDC provider by registering one or more `OidcRequestFiler` implementations, which can update or add new request headers and log requests.

Good catches. Fixed.

@sheilamjones
Copy link
Contributor Author

Thanks so much @MichalMaler for your great review and suggestions. I implemented almost all, but have a couple of questions to clarify with Sergey.

@sberyozkin
Copy link
Member

@sheilamjones This is another nearly perfect PR, it must have been hard given all the specifics and some mess I've created, thanks, a few suggestions are proposed, nothing major, thanks

@sberyozkin
Copy link
Member

sberyozkin commented Jan 16, 2024

@sheilamjones Only 4 minor suggestions are open, nearly ready to go, thanks

@sheilamjones
Copy link
Contributor Author

Hi @sberyozkin,
Thanks again for your time and additional reviews of this one. I have updated per your suggestions. With regards to the use of "recommends", we are not meant to use this in our Docs according to our guidelines. Instead, we are to make a direct statement. I did this for line 662. If this looks okay with you, this one is ready to merge.
Many thanks,
Sheila

@sheilamjones sheilamjones marked this pull request as ready for review January 16, 2024 17:12
@sheilamjones
Copy link
Contributor Author

Hi @sberyozkin, Thanks again for your patience with this PR and for all your great reviews. I completed the additional couple of changes based on your feedback. This is now ready for your final signoff and merge.
Kind regards,
Sheila

Copy link
Member

@sberyozkin sberyozkin left a comment

Choose a reason for hiding this comment

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

Thanks Sheila

Quarkus Documentation automation moved this from To do to Reviewer approved Jan 16, 2024
@sberyozkin sberyozkin added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jan 16, 2024
@sberyozkin sberyozkin merged commit 351bca5 into quarkusio:main Jan 16, 2024
5 checks passed
Quarkus Documentation automation moved this from Reviewer approved to Done Jan 16, 2024
@quarkus-bot quarkus-bot bot added this to the 3.7 - main milestone Jan 16, 2024
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jan 16, 2024
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
Development

Successfully merging this pull request may close these issues.

None yet

4 participants