chore: update group docs to describe subgroups and inherited roles#3824
chore: update group docs to describe subgroups and inherited roles#3824
Conversation
|
|
||
| A user's role in an ancestor group is inherited by descendant groups. | ||
|
|
||
| ## Subgroups example |
There was a problem hiding this comment.
| ## Subgroups example | |
| ## Subgroups explainer |
There was a problem hiding this comment.
I'm not sure that "explainer" is clearer than "example" (is it even a word?)
There was a problem hiding this comment.
We're trying to deter people from creating them - as there's no guarantee that it'll be something Lagoon always supports - ad they introduce a lot of complexity that is better resolved elsewhere. Rather than telling people how to create them, I wanted to explain how they work when inherited (eg via gitlab sync)
There was a problem hiding this comment.
there's no guarantee that it'll be something Lagoon always supports - ad they introduce a lot of complexity that is better resolved elsewhere
Should we say that directly in this section then?
There was a problem hiding this comment.
I updated the title of the section to hopefully be clearer, and also enhanced the warning on the page. Let me know if that is any better?
| Groups can be nested to an arbitrary depth. | ||
| Subgroups are groups which are a child of another group. | ||
|
|
There was a problem hiding this comment.
| Groups can be nested to an arbitrary depth. | |
| Subgroups are groups which are a child of another group. | |
| Subgroups cannot be created or managed via the UI or the CLI; they will only be created via the legacy automated user sync tooling. | |
| Groups can be nested to an arbitrary depth. | |
| Subgroups are groups that are a child of another group. | |
There was a problem hiding this comment.
They can be created via the API, but not the CLI
Subgroups cannot be created or managed via the UI or the API
There was a problem hiding this comment.
This is great, I knew I wasn't the only one confused about subgroups!
There was a problem hiding this comment.
Added a note, hopefully that helps?
|
Added a couple of updates to highlight just how rare these are, and to explain the complexities of dealing with them. |
* fix typo * clean up diagram * enhance warning
3 participants
General Checklist
Affected Issues have been mentioned in the Closing issues sectionThis PR adds documentation which briefly describes subgroups and how they work with permissions in Lagoon.
Closing issues
n/a