Improve searchability of OIDC documents #1728
Conversation
|
🙈 The PR is closed and the preview is expired. |
| description: This guide demonstrates how your Quarkus application can use a LDAP directory to store your user identities. | ||
| keywords: security | ||
| - title: Using OpenID Connect (OIDC) to Protect Service Applications | ||
| url: /guides/security-openid-connect |
There was a problem hiding this comment.
This URL is the 2.7 state.
The 3.1 URL for this guide is: /security-oidc-bearer-token-authentication-tutorial
| url: /guides/security-ldap | ||
| description: This guide demonstrates how your Quarkus application can use a LDAP directory to store your user identities. | ||
| keywords: security | ||
| - title: Using OpenID Connect (OIDC) to Protect Service Applications |
There was a problem hiding this comment.
This title is also obsolete.
The current 3.1 title is Protect a web application by using OpenID Connect (OIDC) authorization code flow.
michelle-purcell
left a comment
michelle-purcell
left a comment
There was a problem hiding this comment.
@sberyozkin - Keywords LGTM 👍
Although, it looks like the current data/guides-latest.yaml is outdated as per my comments.
@ebullient - Does this file get dynamically updated by the doc builds? Should we be updating this manually every time we rename and redirect a Quarkus adoc file?
FYI: For SEO, where possible, we try to include the most popular keywords, phrases, or terms that customers might use to find stuff in the main title, headings, abstract, and main body of the content source. Google and other well-known search engines index more content elements than the Quarkus search function, which only seems to observe keywords/terms in the titles and abstract of the guide source plus other external files like the one above. See related GitHub issue #33215.
|
I tried to address your comments and got confused, because, right now:
The last 2 points are not really relevant for this work, but I'll just take care of them along the way. The first 2 ones are relevant :-), and after quarkusio/quarkus#34070, file names would have to change too :-) I propose that in this PR we just take care of the tags/key words, as it is really a standalone PR, to address your comments properly we need to do some work first in the main repo. Does it sound reasonable ? |
|
Let me merge this one as I've noticed Michelle approved, @michelle-purcell I'll follow up with some updates in the main repo as suggested above, and then I'll ping you to discuss how to best manage your suggestions above, thanks |
2 participants
This PR adds more key words to OIDC docs to improve their searchability.
Every OIDC doc gets extra
oidc,oauth2tags because in reality Quarkus OIDC support bothoidcandoauth2.jwtis also added since it is a base block of these technologies, so when users typejwt, they should be able to see OIDC docs too (in fact for now I added it to the OIDC services doc only which is probably enough).Additionally the well-known providers doc gets an extra key word per every supported provider as discussed as F2F (CC @maxandersen )