JmikolaAutoLoginBundle icon indicating copy to clipboard operation
JmikolaAutoLoginBundle copied to clipboard

update documentation

Open gondo opened this issue 9 years ago • 6 comments

  • add example of generated autologin link
  • add description how to generate such links
  • current Usage section of README.md is in fact About section, it doesn't talk about how to actually use things

gondo avatar May 13 '15 20:05 gondo

:+1:

nebkam avatar Aug 09 '15 11:08 nebkam

The bundle itself does not include anything in order to generate those links but https://github.com/vandpibe/autologin which is built to do exactly this does. There arent that much activity on that code, but it works (we use it a couple of places).

henrikbjorn avatar Aug 13 '15 13:08 henrikbjorn

@henrikbjorn to be fair, https://github.com/vandpibe/autologin doesn't even have proper README file and http://vandpibe.bjrnskov.dk/ does not respond i consider both this repos dead and most likely i ll create my own autologin bundle

gondo avatar Aug 13 '15 13:08 gondo

@gondo i can create the README

The domain dosent respond since i changed the dns provider. However the documentation is still online and can be found at https://github.com/Vandpibe/vandpibe.bjrnskov.dk/blob/master/auto-login.rst

henrikbjorn avatar Aug 13 '15 13:08 henrikbjorn

@henrikbjorn: Do you have a corresponding bundle for https://github.com/vandpibe/autologin, or is that unnecessary?

  • add example of generated autologin link
  • add description how to generate such links

As @henrikbjorn mentioned, that's outside the responsibility of this bundle and the library. All my library provides is a mechanism for looking up users by some token field and authenticating them within Symfony's security context.

As for documenting the usage, test cases would likely help there, but I've not had the time to resolve #4 and jmikola/AutoLogin#4. I'm open to merging a PR on those, or a readme contribution derived from Vandpibe's readme.

jmikola avatar Aug 14 '15 19:08 jmikola

@jmikola I dont think there is a need for a bundle for it. It is just simple services that can easily be added.

It could be build into this bundle, so if the classes are available it would be added automatically. I think the on-invalid="ignore" would handle that.

henrikbjorn avatar Aug 15 '15 18:08 henrikbjorn