search

aaronrenner / phx_gen_auth

An authentication system generator for Phoenix 1.5 applications.
772 stars 55 forks source link

Add note about the binary-id flag to the readme #58

Closed pdgonzalez872 closed 4 years ago

pdgonzalez872 commented 4 years ago

as discussed here: https://github.com/aaronrenner/phx_gen_auth/issues/57

pdgonzalez872 commented 4 years ago

@aaronrenner maybe this got buried? If you don't want to merge it in, no worries! Just touching base on this. Thanks!

aaronrenner commented 4 years ago

@pdgonzalez872 Thanks for the PR. Since phx_gen_auth automatically uses binary ids if the original phoenix app was generated with binary ids, I’m not sure that this needs to be called out as prominently in the README. However, I have been leaving it open to remind me to see if I can add some more info to the docs about it. I appreciate you sharing that this was confusing and I’ll keep thinking about making this info easier to discover.

pdgonzalez872 commented 4 years ago

Oh interesting, that was not my use case at first. I created a phx app, then said: cool, let's use the auth generator. No thoughts further than that at that time.

Interesting about not wanting to add to the readme. I guess I see it as a great feature that I'd want to be loud about up front, not something I'd want to add as a side note a couple of clicks away. Just my opinion though :) Maybe this would belong in a guide instead?

Feel free to keep it open and I won't be sad if you don't end up using it. Just thought you'd want some UX experience.

Thanks for the generator! :heart: !!

wulymammoth commented 4 years ago

@pdgonzalez872 I think you make a fair point, but to keep the documentation for gen-auth concise, I think it makes sense to move it to a guide or FAQ when/if there is one. It would be worth mentioning in the Phoenix Guides in my opinion

I think gen-auth following whatever has already been established in a Phoenix app makes sense. It would be worth calling out if, by default, gen-auth used something different IMO

Seeing how many questions come up related to various aspects of gen-auth, I think an FAQ somewhere would help, because the questions range from general questions about how to do authentication, to authentication patterns, and all the way to the naming scheme used, so what I'm thinking it should cover at minimum are:

  1. understanding authentication and the various protocols -- link to some resource, because I think the primary consumer for gen-auth has a general understanding of authentication
  2. what gen-auth is
  3. what gen-auth is NOT
aaronrenner commented 4 years ago

@pdgonzalez872 Thanks for submitting a PR for this.

I ended up adding the note to the Readme like you suggested, but reworked the wording a bit.

pdgonzalez872 commented 4 years ago

Cool! Thank YOU for the generator!

On Tue, Sep 1, 2020, 00:01 Aaron Renner notifications@github.com wrote:

@pdgonzalez872 https://github.com/pdgonzalez872 Thanks for submitting a PR for this.

I ended up adding the note to the Readme like you suggested, but reworked the wording a bit.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/aaronrenner/phx_gen_auth/pull/58#issuecomment-684249997, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACD6M5QQVF3W5ZTF77ORCNLSDR52DANCNFSM4PIYNBXA .