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.

Sign up for GitHub

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

Jump to bottom

Documentation for server permissions #38

Merged
merged 13 commits into from
Mar 9, 2021
Merged

Documentation for server permissions #38

merged 13 commits into from
Mar 9, 2021
+267 −1

Conversation

The-Noah
Copy link
Contributor

@The-Noah The-Noah commented Jan 5, 2021

This is mostly complete; it just needs a few final tweaks before it's ready. I put this here so I can get feedback.

  • info permission needs a description (I have no clue what this does).
  • The wording could be improved.

@The-Noah
Add documentation for server permissions

Verified

This commit was signed with the committer’s verified signature.
digitalresistor Delta Regeer
GPG key ID: 6521BC4A45BFCE7A
Verified
Learn about vigilant mode
8900a73
@The-Noah The-Noah changed the title Add documentation for server permissions Documentation for server permissions Jan 5, 2021
@allejo
Copy link
Member

allejo commented Jan 5, 2021

Instead of maintaining this document manually, I would prefer to keep this as a YAML document. Take a look at how "Community Links" are managed (i.e. _data/community.yaml).

I'd envision a structure to look like so:

- permission: adminMessageReceive
  description: Receives messages sent to the admin channel
# ...
- permission: actionMessage
  slash-command: me
# ...
- permission: antiban
  immunity-for: ban

Having all of this data as YAML will allow us to easily interlink files together 😄 For example, see permissions in the Front Matter for _documentation/user/slash_commands/ban.md. We'd be able to link the two documents together and even have ids for each permission. See how we handle listing slash commands in _pages/documentation/user/slash-commands/list.html.twig.

@The-Noah
Copy link
Contributor Author

The-Noah commented Jan 5, 2021

Thank you so much! I'll get to work on this.

@The-Noah
Use yaml for server permissions

Verified

This commit was signed with the committer’s verified signature.
digitalresistor Delta Regeer
GPG key ID: 6521BC4A45BFCE7A
Verified
Learn about vigilant mode
20a3e38
@The-Noah The-Noah marked this pull request as ready for review January 6, 2021 17:11
allejo
allejo requested changes Jan 6, 2021
View reviewed changes
Copy link
Member

@allejo allejo left a comment

Choose a reason for hiding this comment

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

These changes make things a bit more verbose but it helps a lot with interlinking between data (e.g. this data file linked to slash commands automagically)

The-Noah and others added 2 commits January 6, 2021 12:53
@The-Noah @allejo
Apply suggestions from code review

Verified

This commit was signed with the committer’s verified signature.
digitalresistor Delta Regeer
GPG key ID: 6521BC4A45BFCE7A
Verified
Learn about vigilant mode
4264a1a 
Co-authored-by: Vladimir Jimenez <allejo@me.com>
@The-Noah
Add missing poll permission
ddcb9c7
@The-Noah The-Noah requested a review from allejo January 6, 2021 18:56
@The-Noah
Copy link
Contributor Author

The-Noah commented Jan 6, 2021

I've merged in your suggestions, thanks!

Sorry, something went wrong.

jwmelto
jwmelto reviewed Jan 7, 2021
View reviewed changes
Copy link
Member

@jwmelto jwmelto left a comment

Choose a reason for hiding this comment

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

As usual, I have little insight into this framework, but I appreciate your work in adding to the documentations.

Sorry, something went wrong.

The-Noah and others added 7 commits January 7, 2021 10:54
@The-Noah @jwmelto
Fix typo in server_permissions.yaml
8ca1db8 
Co-authored-by: jwmelto <jwmelto@users.noreply.github.com>
@The-Noah @jwmelto
Update _pages/documentation/developer/server-permissions.html.twig
3f27c0f 
Co-authored-by: jwmelto <jwmelto@users.noreply.github.com>
@The-Noah
Make server_permissions.yaml more readable
339a91b
@allejo @The-Noah
Have slash_commands collection be perm authority
ee8813d 
Don't duplicate the data between our `server_permissions` data file and
our `slash_commands` collection. The collection will remain the
authority with which permissions tie to said commands.

Co-authored-by: The Noah <thenoahbz@gmail.com>
@allejo
Remove nonexistent loadPlugins and unloadPlugin
d40c498
@allejo
Remove 'info' permission
3fd353c
@allejo
Remove 'listPerms' which seems to be unused
e9e187a
@allejo allejo requested a review from jwmelto January 10, 2021 01:44
allejo
allejo approved these changes Jan 10, 2021
View reviewed changes
Copy link
Member

@allejo allejo left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for your work on this @The-Noah! and thanks for being patient with us as we figured out how to organize this documentation.

Organization wise, this looks good to me. Let's wait to get feedback from others on whether or not we need more information for this PR.

@The-Noah
Copy link
Contributor Author

I'm glad I could help, and thank you @allejo for making this 10x better!

@allejo allejo mentioned this pull request Jan 10, 2021
Open
3 tasks
@allejo allejo merged commit 5be8ac5 into BZFlag-Dev:master Mar 9, 2021
@The-Noah The-Noah deleted the docs/server-permissions branch March 9, 2021 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@allejo allejo

@blast007 blast007

@jwmelto jwmelto

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@The-Noah @allejo @jwmelto