Skip to content

Add Figures to Resource Server Docs #8184

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

Closed

Conversation

jzheaux
Copy link
Contributor

@jzheaux jzheaux commented Mar 24, 2020

Fixes gh-8182

@jzheaux jzheaux requested a review from rwinch March 24, 2020 21:29
@jzheaux jzheaux added this to the 5.4.0.M1 milestone Mar 24, 2020
@jzheaux jzheaux added in: oauth2 An issue in OAuth2 modules (oauth2-core, oauth2-client, oauth2-resource-server, oauth2-jose) status: duplicate A duplicate of another issue type: enhancement A general enhancement labels Mar 24, 2020
@jzheaux jzheaux force-pushed the docs-oauth2-resource-server branch from d8e8701 to 5845d30 Compare March 24, 2020 21:37
Copy link
Member

@rwinch rwinch left a comment

Choose a reason for hiding this comment

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

The diagrams look good.

I'd consider another ticket to take a look at the overall structure of the document. Looking at the TOC it is surprising to me that how Opaque Token Authentication Works is in Minimal Configuration for Introspection -> RuntimeExpectations. I'd think that Resource server would have some sort of introduction that lead to JWT and Opaque support top level sections.

@jzheaux
Copy link
Contributor Author

jzheaux commented Mar 25, 2020

@rwinch Yes, I mulled over this for some time, and I think there's value in bumping it out in the hierarchy - perhaps into its own section.

Wherever it goes, I believe it's important to lead with examples, meaning that I believe it should follow the minimal sample. Following "Runtime Expectations" felt the most natural since that section is still in the business of talking about the minimal sample.

The documentation as it stands in this PR begins with a small amount of architectural overview about Bearer Token as a whole only because there is no example that can be formulated at that point in the docs. But, once we get to JWT and opaque token, we can show an example, say "now what did we just see?", and proceed with architectural detail.

I see this as quite similar to what the early servlet docs do: Start with a minimal boot example in section 8, and then go into detail on how things work in section 9.

@jzheaux
Copy link
Contributor Author

jzheaux commented Mar 25, 2020

Merged via e62b8a7 to master

@jzheaux jzheaux closed this Mar 25, 2020
@jzheaux jzheaux deleted the docs-oauth2-resource-server branch March 25, 2020 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: oauth2 An issue in OAuth2 modules (oauth2-core, oauth2-client, oauth2-resource-server, oauth2-jose) status: duplicate A duplicate of another issue type: enhancement A general enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Figures to Resource Server Docs
2 participants