BZFlag-Dev / bzflag.org

The bzflag.org static website
https://www.bzflag.org
MIT License
8 stars 7 forks source link

Documentation for server permissions #38

Closed The-Noah closed 3 years ago

The-Noah commented 3 years ago

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

allejo commented 3 years ago

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 :smile: 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 commented 3 years ago

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

The-Noah commented 3 years ago

I've merged in your suggestions, thanks!

The-Noah commented 3 years ago

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