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

Add links to Well-Known OIDC providers doc #33641

Merged

Conversation

sberyozkin
Copy link
Member

Fixes #33056.

Hi @michelle-purcell @sheilamjones, it is an attempt to make the Well Known Providers doc more visible from within OIDC specific docs and sections, I've added extra links from the authentication mechanism concept doc, in the OIDC code flow concept and tutorials, and along the way updated the reference links section on the code flow tutorial (non-Quarkus doc links moved to the very end, minor optimization in the Summary section).
Have a look please.
The plan is to follow up with adding tags like google, github etc in the website for the users to immediately find the Well Known Providers doc if they type for example twitter in the Search area.
Do you think though if we can also add such tags to the Well Known Providers doc itself with this PR ?
Thanks

@github-actions
Copy link

github-actions bot commented May 26, 2023

🙈 The PR is closed and the preview is expired.

@sberyozkin sberyozkin marked this pull request as ready for review May 31, 2023 13:25
@sberyozkin
Copy link
Member Author

sberyozkin commented May 31, 2023

Hey @michelle-purcell @sheilamjones I think simplest would be to add provider tags to the website, I'll follow up with another PR later

@sheilamjones
Copy link
Contributor

Hi @sberyozkin,
Thanks for this update and apologies for slow reply. I will take a look this afternoon and get back to you directly.
Kind regards,
Sheila

@sberyozkin
Copy link
Member Author

Hi @sheilamjones Np at all, take your time please, I'll be signing off shortly for the evening, back tomorrow morning, thanks

Copy link
Contributor

@michelle-purcell michelle-purcell left a comment

Choose a reason for hiding this comment

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

It would be great to add a mention and reference for the following topic to the Quarkus Security overview page:

xref:security-openid-connect-providers.adoc[Configuring Well-Known OpenID Connect Providers]

For example here/References link section:

image

@michelle-purcell
Copy link
Contributor

@sberyozkin - Looks great 👍 Super job. See my comments above. Thanks.

@sheilamjones
Copy link
Contributor

Thanks @sberyozkin for making these updates. They look great and also had a few small additional comments. With regards to the title of the existing [Configuring Well-Known OpenID Connect Providers] guide, would it be possible to update the title of the guide itself in this PR also to change it to sentence case, that is, "Configuring well-known OpenID Connect providers" or ""Configuring commonly-used OpenID Connect providers" if you choose that alternative term?

@sberyozkin sberyozkin force-pushed the oidc_well_known_providers_doc_search branch from 618aa6e to 5cdee63 Compare June 1, 2023 13:56
@sberyozkin
Copy link
Member Author

Hey @michelle-purcell @sheilamjones
Looks like Configuring is now added everywhere with your suggestions, have a look please. Are you OK with retaining Well-Known (and we now have Commonly used used in one of the references as well) ? Hopefully it should be fine

@michelle-purcell
Copy link
Contributor

If well-known is a well-known security term (:wink: ) familiar to Java developers who want to use/start using Quarkus then let's keep it. @sheilamjones ?

@sheilamjones
Copy link
Contributor

Thanks for your updates @sberyozkin. And I am fine to keep "well-known" then too in this context. I just had a couple of additional minor comments for your consideration. Thank you :)

@sberyozkin
Copy link
Member Author

Hey @michelle-purcell well-known is not really a security term, true, but IMHO this is what providers like Google etc are, they are well-known. Is commonly-used better ? May be, but is it a security term :-) ?

@sberyozkin sberyozkin force-pushed the oidc_well_known_providers_doc_search branch from 5cdee63 to 13f3a93 Compare June 1, 2023 15:27
@sberyozkin
Copy link
Member Author

Thanks @sheilamjones, done.

@sheilamjones @michelle-purcell thanks for a great review 👍 , very welcome, security docs can only become better after your reviews :-)

@sberyozkin
Copy link
Member Author

Hi @gastaldi @geoand This PR has been reviewed by Michelle and Sheila, can you double check please this PR and add an approval letting me merge ? I'll follow up with another one to the website so that tags like twitter etc can be used to find the guide

@gastaldi gastaldi merged commit cf7ab81 into quarkusio:main Jun 2, 2023
@quarkus-bot quarkus-bot bot added the kind/enhancement New feature or request label Jun 2, 2023
@quarkus-bot quarkus-bot bot added this to the 3.2 - main milestone Jun 2, 2023
@sberyozkin
Copy link
Member Author

Thanks @gastaldi

@sberyozkin sberyozkin deleted the oidc_well_known_providers_doc_search branch June 2, 2023 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve searchability of OIDC well known providers guide
4 participants