Skip to content
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

docs(acl): Add Groups and ACL documentation #188

Merged
merged 19 commits into from
Jun 25, 2023
Merged

docs(acl): Add Groups and ACL documentation #188

merged 19 commits into from
Jun 25, 2023

Conversation

Kissaki
Copy link
Member

@Kissaki Kissaki commented Mar 19, 2023

Not included:

  • @sub a common parent parameter description and example
  • "Context" terminology as ACL rule inheritance(?) is called in the Mumble UI

Establishes terminology beyond Mumble client UI:

  • [ACL] rule
  • [rule] selector
  • [rule] action (for allow / deny / nothing - used in text only once right now)

@Kissaki
Copy link
Member Author

Kissaki commented Mar 19, 2023

I had trouble confirming @sub a common parent parameter behavior and constructing/having a test case for it.

We could add that later so that we already have this documentation available.

@Kissaki Kissaki requested a review from Krzmbrzl March 19, 2023 11:24
@Kissaki

This comment was marked as outdated.

@Kissaki
Copy link
Member Author

Kissaki commented Mar 19, 2023

There's opportunity for more screenshots, and reducing their default display size. But we can handle those as followup improvements.

hugo/content/documentation/administration/acl/index.md Outdated Show resolved Hide resolved
hugo/content/documentation/administration/acl/index.md Outdated Show resolved Hide resolved
hugo/content/documentation/administration/acl/index.md Outdated Show resolved Hide resolved
hugo/content/documentation/administration/acl/index.md Outdated Show resolved Hide resolved
hugo/content/documentation/administration/acl/index.md Outdated Show resolved Hide resolved
hugo/content/documentation/administration/acl/index.md Outdated Show resolved Hide resolved
hugo/content/documentation/administration/acl/index.md Outdated Show resolved Hide resolved
hugo/content/documentation/administration/acl/index.md Outdated Show resolved Hide resolved
Kissaki and others added 16 commits April 8, 2023 22:05
Co-authored-by: Robert Adam <dev@robert-adam.de>
Co-authored-by: Robert Adam <dev@robert-adam.de>
Co-authored-by: Robert Adam <dev@robert-adam.de>
Tilde rules are inherited like any other rule
It is not a meta group. Although a default, added by default, requires members to be added manually.

@admin is mentioned before as default - so no need to add anything for this removal.
@Kissaki Kissaki marked this pull request as ready for review June 10, 2023 14:42
@Kissaki
Copy link
Member Author

Kissaki commented Jun 10, 2023

@Krzmbrzl I resolved all your comments. Can you please take another look?

I think this would be a good starting point. We can handle additions and improvements later (add sub sibling examples, possibly reduce / adjust screenshot sizes, possibly go for more of a user -> user groups -> meta groups cascade).

@Kissaki Kissaki merged commit 66042c6 into master Jun 25, 2023
@Kissaki Kissaki deleted the docs/acl branch June 25, 2023 15:22
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.

2 participants