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

Document Commands & Permissions #30

Open
benrobson opened this issue Jan 30, 2020 · 3 comments
Open

Document Commands & Permissions #30

benrobson opened this issue Jan 30, 2020 · 3 comments
Labels
enhancement New feature or request

Comments

@benrobson
Copy link
Contributor

I have been looking into using TGM for my own Server and I found it very difficult to get all the permission nodes to apply them to my user groups. I would've thought there was a resource for this but when I asked in the contributing channel, one hasn't been made.

@BennyDoesStuff
Copy link
Collaborator

I'm not too sure where commands and permissions should be documented. I was thinking that we could try putting it under the "General" section, but the documentation seems to be more focused on the JSON aspects of the plugin rather than the plugin itself.

Image

We might want to make a different section or category to group the JSON aspects together, and then make another section for the plugin itself. That way, we can include all the commands and permissions as well as anything else related to the plugin such as the API, setting up a server and database, etc.

@BennyDoesStuff BennyDoesStuff added the enhancement New feature or request label Feb 1, 2020
@benrobson
Copy link
Contributor Author

I think under General you could add Commands & Permissions with a table of the command, the description and the permission node.
Especially for people like me, looking to use Warzone as a Game Manager, documentation is important to be able to know how to use it and how it operates.
It may seem like a small suggestion but it's an investment for those who will seek to use and contribute to the project.

@benrobson
Copy link
Contributor Author

Completed in https://github.com/benrobson/Docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants