EngineHub / CommandBook

General and administrative commands
https://enginehub.org/commandbook/
GNU Lesser General Public License v3.0
145 stars 105 forks source link

The plugin documentation process needs to be improved #238

Closed LadyCailinBot closed 4 years ago

LadyCailinBot commented 10 years ago

CMDBOOK-2353 - Reported by Knut.Remi.Løvli

Basically, server admins need to be told to subscribe to the issue tracker feed or follow someone on Twitter before installing the plugin(s). And the Wiki needs to be updated with user and admin documentation as soon as these changes occur. That is, if the plugins are going to keep hijacking commands from other plugins, add features that can be used for privilege escalation or other potentially disruptive things. Read my rationale for this below.

Some months ago, the fly plugin on my server stopped working. I only got around to fixing the problem recently. I tried all kinds of permission trickery, then I tried replacing the plugin with another one and played around with the permissions again. Only after a player on my server suggested that I use Essentials, and then CommandBook, did it occur to me that it might have been commandbook who hijacked the /fly command from our flight plugin. I took a look at the permission documentation to see if that might have been the case, but there was nothing on it there. The same thing happened back when I discovered that my WorldGuard region owners could set their own game mode in regions they own with the game-mode flag, even without commandbook.gamemode.change or your equivalent permission. Of course it wasn't documented then either.

I've got 36 plugins installed. And while I could take the time to read through every single change log when I update them, I'd rather play Minecraft instead. I only now discovered the a cryptic message about a flight component in the 2.3 change log. My point is, CommandBook and other plugins like it, need to make sure the message about new features with potentially disruptive side effects gets across. That goes for when they hijack commands, or changes are made that could be used for privilege escalation. Like the previously undocumented game-mode flag in WorldGuard.

LadyCailinBot commented 10 years ago

Comment by Dark_Arc

Read the change logs, we're not going to make flashy red text saying that we added a new command which you might already have. I'll see if I can find some time to update the documentation, or you could do it if you really want to.

LadyCailinBot commented 10 years ago

Comment by Dark_Arc

http://wiki.sk89q.com/wiki/CommandBook/Commands#Flight

LadyCailinBot commented 10 years ago

Comment by Knut.Remi.Løvli

I subscribed to the issues feed and I followed you on GitHub now, so I might have the means to update the Wiki once I see changes. But my point is, server admins need to be told to watch your change logs. And even better, some kind of news feed would help a lot.