Skip to content

Docs: Keycloak OIDC Guide#4113

Merged
foot merged 5 commits intoweaveworks:mainfrom
mircea-pavel-anton:docs/keycloak_oidc_guide
Nov 22, 2023
Merged

Docs: Keycloak OIDC Guide#4113
foot merged 5 commits intoweaveworks:mainfrom
mircea-pavel-anton:docs/keycloak_oidc_guide

Conversation

@mircea-pavel-anton
Copy link
Copy Markdown
Contributor

Addresses #4109

What changed?

Improved documentation to contain a step-by-step guide of configuring the Keycloak OIDC integration.

Why was this change made?

The documentation for the generic OIDC setup was not clear enough as to make the process seamless.

How did you validate the change?

By following the steps described in the guide 😆

Release notes

Documentation Changes

Not really, it's just docs.

@mircea-pavel-anton
Copy link
Copy Markdown
Contributor Author

@bigkevmcd here is the PR for the Keycloak guide we talked about!

@mircea-pavel-anton mircea-pavel-anton marked this pull request as draft November 1, 2023 11:51
@mircea-pavel-anton
Copy link
Copy Markdown
Contributor Author

I need to look a bit more into the file structure and the actual website config as I am not familiar with docusaurus at all 😅
But the content itself is pretty much done

Copy link
Copy Markdown
Contributor

@bigkevmcd bigkevmcd left a comment

Choose a reason for hiding this comment

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

This looks fantastic, I'll find out "where" to put it, but otherwise I'd be happy to accept this, thanks for the work.

Copy link
Copy Markdown
Member

@makkes makkes left a comment

Choose a reason for hiding this comment

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

Thanks for this wonderful guide. I left some comments.

@bigkevmcd as to where to leave this, I think after merging in #3917 we can incorporate it either into that page or as a distinct page and link to it from the general OIDC guide.

Comment thread website/docs/guides/sso/keycloak/configuring-oidc-with-keycloak.mdx Outdated
Comment thread website/docs/guides/sso/keycloak/configuring-oidc-with-keycloak.mdx Outdated
Comment thread website/docs/guides/sso/keycloak/configuring-oidc-with-keycloak.mdx Outdated
@mircea-pavel-anton
Copy link
Copy Markdown
Contributor Author

@makkes I will look on the comments this weekend and fix everything up! Thanks

@mircea-pavel-anton mircea-pavel-anton marked this pull request as ready for review November 21, 2023 13:57
@makkes
Copy link
Copy Markdown
Member

makkes commented Nov 21, 2023

@mirceanton can you please rebase your branch on top of main, get rid of the merge commits and squash the commits into a single one?

@mircea-pavel-anton
Copy link
Copy Markdown
Contributor Author

@makkes done. Rebased and squashed. Though I must ask, why squash the commits on the MR instead of git merge --squash?

@makkes
Copy link
Copy Markdown
Member

makkes commented Nov 21, 2023

I replaced the Keycloak guide in the OIDC guide with a link to this new page and also moved this page to the top-level section for simplicity. Great job @mirceanton! /cc @bigkevmcd

Comment thread website/docs/guides/configuring-oidc-with-keycloak.mdx
Copy link
Copy Markdown
Member

@makkes makkes left a comment

Choose a reason for hiding this comment

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

Ready to merge.

mircea-pavel-anton and others added 5 commits November 22, 2023 11:40
We shouldn't make the navigation more complex as it needs to be. The
"guides" section only has 4 guides right now so it provides a better
UX if we keep it flat.
The namespaced RoleBinding isn't necessary when the group is granted
cluster admin access.
@foot foot merged commit 6f7980b into weaveworks:main Nov 22, 2023
@makkes
Copy link
Copy Markdown
Member

makkes commented Nov 22, 2023

Thanks a lot, @mirceanton. This will definitely save users from a lot of headaches. 👏🏻 🎖️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants