Documentation added for OAuth

[SidharthBansal]

Fixed #2848

[plotsbot]

	1 Message
📖	@SidharthBansal Thank you for your pull request! I’m here to help with some tips and recommendations. Please take a look at the list provided and help us review and accept your contribution! And don’t be discouraged if you see errors – we’re here to help.

Generated by 🚫 Danger

[SidharthBansal]

@jywarren kindly review this too

[jywarren]

This is really nice. Shall we update it to reflect the environment variables instead of using application.yml?

[SidharthBansal]

This file is important because we don't want the developer to push his app_id and app_secret onto the github. We have enabled .gitignore to not include application.yml file while we push onto plots2 and we have enabled figaro too. It will be easiest to write the keys and values in application.yml in such cases.

[jywarren]

Hi, Sidharth - we've set this up to use environment variables from the host system directly in your code in #2771, so there should be no situation where developers need to input their secrets into a file. If you'd like to rewire this so that it looks more like this file: https://github.com/publiclab/plots2/blob/master/config/initializers/recaptcha.rb That's fine too, but you can see there also we don't explicitly put real codes in... they're passed in through environment variables. This really reduces the chances that a secret will be pushed. Does this system make sense? @icarito may be able to explain a bit more as well. Thank you for bearing privacy in mind!

…

On Wed, Jun 20, 2018 at 3:09 PM Sidharth Bansal ***@***.***> wrote: This file is important because we don't want the developer to push his app_id and app_secret onto the github. We have enabled .gitignore to not include application.yml file while we push onto plots2 and we have enabled figaro too. It will be easiest to write the keys and values in application.yml in such cases. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2855 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJ3C5FYcoywn0na3kZcum-eM1oUelks5t-p3bgaJpZM4Utj7G> .

[SidharthBansal]

OK. I am pushing some changes to the documentation.
Thanks

[jywarren]

This looks great. Is it ready? I'd ask perhaps that you change he/she has to they have and generally use they -- thank you!

VERY good documentation!!!

[SidharthBansal]

Thanks for the suggestion. I will keep this in mind.
Will push the required changes tonight

[SidharthBansal]

@jywarren I have changed the file according to the changes suggested.
It is ready for merge

[jywarren]

Awesome!!