Skip to content
This repository has been archived by the owner on Jul 21, 2021. It is now read-only.

Improve documentations #9

Open
lambdalisue opened this issue Jan 24, 2014 · 2 comments
Open

Improve documentations #9

lambdalisue opened this issue Jan 24, 2014 · 2 comments

Comments

@lambdalisue
Copy link
Contributor

More detailed documentations like below are required.

  • The reason why django-permission is required while there are other object permission
    systems like django-guardian
    • The difference between logic based permission system and database based
      object permission system
    • Several use cases for django-permission (and other object permission systems)
  • Explain about making custom logic permissions
    • Explain the basic concept of logic permissions
    • Some tutorials
  • Explain about django-permission's enhanced permission_required decorator
  • User can use the decorator as a decorator of class, method, or function
  • Explain the basic mechanisms to get user instance and object instance
    automatically
  • Some use cases
  • Explain about django-permission's enhanced if template tag
    • Explain two newly introduced operators (has and of)
    • Explain how to disable overwriting built-in if template tag and the way to use
      permission tag in that case
    • Some use cases
  • Explain how to contribute the development of django-permission
    • Explain the way to test it

I need some persons who check my English to improve the documentations lol.

@luzfcb
Copy link

luzfcb commented Apr 22, 2014

@lambdalisue
Another item to documentation:

  • Explain how to use with class based views

A good explanation of why I should use the django-permission and not django-guardian also would be great, and a crazy idea, it is also if possible to use them together.

I found it very interesting implementation of role-based permissions, as you implemented in "third-impact"[1] project ( some of you seem to like Neon Genesis Evangelion 😆)

seems to me an excellent candidate to enter as an example in the documentation

[1] https://github.com/kawazrepos/third-impact/blob/develop/src/kawaz/core/permissions/logics/role.py

ps: sorry for ugly English. I do not speak English, I'm still learning. But the google translator helps a little. I speak Brazilian Portuguese

@lambdalisue
Copy link
Contributor Author

Haha, thanks for the comments.

Yeah, I agree with your idea I'll try when ever I got a time to do.
Writing the documentation is always most difficult things....

and a crazy idea, it is also if possible to use them together.

Theoretically you can. I have not tried so theoretically.

I found it very interesting implementation of role-based permissions, as you implemented in "third-impact"

Oh, you found that lol. Well that project is the on-going one and the new styled role-based permission is also trial strategy (it might be buggy while I'm removing is_staff and is_superuser in database level with some hackish code https://github.com/kawazrepos/third-impact/blob/is_staff_issue/src/kawaz/core/personas/models.py#L51). So I need to confirm the stability of that strategy first.
Actually this django-permission or other django plugins on my github were made for building that project. Thus the qualities of my plugins will be improved within several month by using these plugins heavily in that big project :-)

some of you seem to like Neon Genesis Evangelion 😆

Yes we LOVE 😃

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants