docs: extend group documentation to include information on setting root roles #3696
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Huh. Spec tests have found an issue. I am 99.99% sure it's unrelated given the test but really nice to see they found something! |
| @@ -136,10 +136,15 @@ A user group consists of the following: | |||
| - a **description** (optional) | |||
| - a **list of users** (required) | |||
| - a list of SSO groups to sync from (optional) | |||
| - a root role associated with the group (optional) (only available in **Unleash 5.1** and later) | |||
There was a problem hiding this comment.
I'm unsure about whether this should have the "(only available in ...)" or not. I'm leaning towards yes because it's unreleased for now, but I don't actually think it should stay there. So ... maybe no? What do you think?
There was a problem hiding this comment.
Yeah, I'm also in two minds. We've used this pattern in the past but I'm not 100% sure it's working for us since we apparently never go clean these things up.
That being said, I don't want users to find the docs and then ask why things don't work the way the docs say they should so while I don't like it, I think it should stay
We do seem to be pretty consistent with these version strings in the docs, though, could we script something to check this?
There was a problem hiding this comment.
Sure, I'm happy to do either, so I'll leave it up to you.
We do seem to be pretty consistent with these version strings in the docs, though, could we script something to check this?
Depends on what you're thinking about? We can definitely script things, but what do you want to check exactly?
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
This adds documentation to the RBAC section on how to use root roles on groups and updates a few screenshots for the group pages.