Documentation for requireLogin Class

[SidharthBansal]

Part of #4132.
Add documentation for the new requireLogin class so that we can add that to the new buttons etc in future as per Jeff's suggestion #4132 (comment).

[SidharthBansal]

@oorjitchowdhary are you willing to write this piece of documentation. This will be your first part to write the documentation. Documentation helps in using the function in future.

[SidharthBansal]

This is really close to the work which you did in last couple of weeks.

[oorjitchowdhary]

Hi @SidharthBansal .. Yes I'll do this one..
Where should I add the documentation and how long should it be... 2-3 lines or more?

[SidharthBansal]

2-3 lines. We need to search where it would be the best. We have to add it where this function is implemented for sure. In addition to it ay be we can add to the readme or anything else. I don't think readme will be appropriate place. Any suggestions?

…

On Mon, Jan 7, 2019 at 8:21 PM Oorjit Chowdhary ***@***.***> wrote: Hi @SidharthBansal <https://github.com/SidharthBansal> .. Yes I'll do this one.. Where should I add the documentation and how long should it be... 2-3 lines or more? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4509 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AUACQ_m8YCii-sz8hpzUHCxV1Vyvo6c9ks5vA17rgaJpZM4ZofUE> .

[oorjitchowdhary]

I don't think readme will be appropriate place. Any suggestions?

Yes, I don't think we should put it in the README.. I think it'll be best to create a new file for Login and Signup functionalities just like there is EMAIL.md in /doc

This doc could focus on the login and signup modals we created.. and the use of login and signup pages even after the modals.. and also the requireLogin class

But I'm confused what will we name this file... LOGIN.md or SIGNUP.md won't work as this will comprise of both of them

[SidharthBansal]

Let's take input from @jywarren whether we require to create a separate file for this or not. One way is to change omniauth to login sequences doc and add the documentation there.

…

On Mon, Jan 7, 2019, 10:03 PM Oorjit Chowdhary ***@***.*** wrote: I don't think readme will be appropriate place. Any suggestions? Yes, I don't think we should put it in the README.. I think it'll be best to create a new file for Login and Signup functionalities just like there is EMAIL.md in /doc This doc could focus on the login and signup modals we created.. and the use of login and signup pages even after the modals.. and also the requireLogin class — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4509 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AUACQ_OEpH1KmnnnszgJwSGNAM_5bLpLks5vA3bHgaJpZM4ZofUE> .

[jywarren]

I like this last suggestion on maybe a LOGIN_SYSTEMS.md file? On Mon, Jan 7, 2019 at 9:11 PM Sidharth Bansal <notifications@github.com> wrote:

…

Let's take input from @jywarren whether we require to create a separate file for this or not. One way is to change omniauth to login sequences doc and add the documentation there. On Mon, Jan 7, 2019, 10:03 PM Oorjit Chowdhary ***@***.*** wrote: > I don't think readme will be appropriate place. Any suggestions? > > Yes, I don't think we should put it in the README.. I think it'll be best > to create a new file for Login and Signup functionalities just like there > is EMAIL.md in /doc > > This doc could focus on the login and signup modals we created.. and the > use of login and signup pages even after the modals.. and also the > requireLogin class > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#4509 (comment) >, > or mute the thread > < https://github.com/notifications/unsubscribe-auth/AUACQ_OEpH1KmnnnszgJwSGNAM_5bLpLks5vA3bHgaJpZM4ZofUE > > . > — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4509 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJwPWnrHiaadd0gm36uHwThNYEQZ1ks5vA_4SgaJpZM4ZofUE> .

[SidharthBansal]

OK Oorjit go ahead with Jeff's suggestion. Thanks Jeff On Tue, Jan 8, 2019, 10:38 PM Jeffrey Warren <notifications@github.com wrote:

…

I like this last suggestion on maybe a LOGIN_SYSTEMS.md file? On Mon, Jan 7, 2019 at 9:11 PM Sidharth Bansal ***@***.***> wrote: > Let's take input from @jywarren whether we require to create a separate > file for this or not. > One way is to change omniauth to login sequences doc and add the > documentation there. > > > On Mon, Jan 7, 2019, 10:03 PM Oorjit Chowdhary ***@***.*** > wrote: > > > I don't think readme will be appropriate place. Any suggestions? > > > > Yes, I don't think we should put it in the README.. I think it'll be best > > to create a new file for Login and Signup functionalities just like there > > is EMAIL.md in /doc > > > > This doc could focus on the login and signup modals we created.. and the > > use of login and signup pages even after the modals.. and also the > > requireLogin class > > > > — > > You are receiving this because you were mentioned. > > Reply to this email directly, view it on GitHub > > < #4509 (comment) > >, > > or mute the thread > > < > https://github.com/notifications/unsubscribe-auth/AUACQ_OEpH1KmnnnszgJwSGNAM_5bLpLks5vA3bHgaJpZM4ZofUE > > > > . > > > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#4509 (comment) >, > or mute the thread > < https://github.com/notifications/unsubscribe-auth/AABfJwPWnrHiaadd0gm36uHwThNYEQZ1ks5vA_4SgaJpZM4ZofUE > > . > — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4509 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AUACQwekfnm3_j3nJSD6-4As1otDqg1Gks5vBNCngaJpZM4ZofUE> .

[oorjitchowdhary]

So should I make a new file as LOGIN_SYSTEMS.md or change OMNIAUTH.md to LOGIN_SYSTEMS.md??

[jywarren]

Change it, please -- thank you!

…

On Tue, Jan 8, 2019 at 4:08 PM Oorjit Chowdhary ***@***.***> wrote: So should I make a new file as LOGIN_SYSTEMS.md or change OMNIAUTH.md to LOGIN_SYSTEMS.md?? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4509 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJ7JW4DJXO_PSguzW2CqmQcA5WNLbks5vBQjBgaJpZM4ZofUE> .

[SidharthBansal]

Rename omniauth file. Don't make new one.

…

On Wed, Jan 9, 2019, 2:42 AM Jeffrey Warren ***@***.*** wrote: Change it, please -- thank you! On Tue, Jan 8, 2019 at 4:08 PM Oorjit Chowdhary ***@***.***> wrote: > So should I make a new file as LOGIN_SYSTEMS.md or change OMNIAUTH.md to > LOGIN_SYSTEMS.md?? > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#4509 (comment) >, > or mute the thread > < https://github.com/notifications/unsubscribe-auth/AABfJ7JW4DJXO_PSguzW2CqmQcA5WNLbks5vBQjBgaJpZM4ZofUE > > . > — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4509 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AUACQ9n-9tGSLRavo2JOXJDZsHA93VrIks5vBQnXgaJpZM4ZofUE> .