Skip to content

Keycloak Integration Documentation Page #2867

Open
@josephaw1022

Description

@josephaw1022

Type of issue

Other (describe below)

Description

Not sure if any of this has already been submitted as an issue so apologies in advance if this is redundant. I just was looking over the keycloak docs in place and I really like it and have a few initial thoughts about the keycloak doc page seen here:

https://learn.microsoft.com/en-us/dotnet/aspire/authentication/keycloak-integration?tabs=dotnet-cli

1. Image Placement on Page

I really like the diagram at the bottom of the page

Image

Personally, I think this should be at the top of the page so that the reader knows "the what" at a high level and then "the how" or the c# is shown after. Just to make it easier to follow and understand.

2. Move the json to some external link

The size of the json isn't the issue because it is what it is with keycloak, however, I do think having the a link that the user can go to avoid making the page so long. so instead of embedding the json directly in the page like this

{
    "id": "86683c73-be28-4380-a014-6316c0404192",
    "realm": "WeatherShop",
...
}

I am suggesting having something along the lines of,

As an example, the following JSON file could be added to the app host project in a /Realms folder—to serve as a source realm configuration file:
link to json

Page URL

https://learn.microsoft.com/en-us/dotnet/aspire/authentication/keycloak-integration?tabs=dotnet-cli

Content source URL

https://github.com/dotnet/docs-aspire/blob/main/docs/authentication/keycloak-integration.md

Document Version Independent Id

8191aee1-6f2c-5820-046d-17dc81d997e9

Platform Id

5e989b0e-9189-b101-98d3-b5b72245d36b

Article author

@IEvangelist

Related Issues

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions