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

Create a plugin dev guide for using the granular Access Control system #4

Open
cp2004 opened this issue Aug 26, 2022 · 0 comments
Open

Comments

@cp2004
Copy link
Member

cp2004 commented Aug 26, 2022

It has been on my mind for a while that there is no guide on how to use this system for plugin authors, and the documentation rewrite seems like a good time for this to be written.

The issue OctoPrint/OctoPrint#4632 highlighted the need for some documentation here. The hook is documented, but I don't think some of the other stuff is.

I was thinking of:

  • Making sure octoprint.access is documented properly in 'Internal modules'
  • Adding a quick guide on how the permissions system works and why you should implement it in your plugin

If anyone else wants to pick this up, go for it! otherwise I will probably get to it at some point when more of the documentation is migrated across.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

1 participant