Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs and Re-publish #32

Closed
7 tasks done
nelsonic opened this issue Dec 8, 2019 · 3 comments
Closed
7 tasks done

Update Docs and Re-publish #32

nelsonic opened this issue Dec 8, 2019 · 3 comments

Comments

@nelsonic
Copy link
Member

nelsonic commented Dec 8, 2019

The code in this package/repo works. βœ… πŸŽ‰
But there is nowhere near enough documentation for someone else to use the package without reading the code in /lib ... as a result only we (@dwyl) are using it and nobody else is benefiting from it.

We need to comprehensively document the package (a) because it makes it easier to maintain, (b) it makes it easier (possible) for other people to use it and get their GitHub Auth enabled projects off the ground and (c) other people in the elixir/dwyl community can contribute improvements.
Similar to dwyl/elixir-auth-google#10 and PR: dwyl/elixir-auth-google#11

Thankfully this package's /lib/elixir_auth_github.ex already has pretty decent @doc comments πŸ‘
So all that is missing is are the detailed instructions for getting it setup.

Compare the difference:
before: https://github.com/dwyl/elixir-auth-google/tree/2b1f9b09433fb7845dff00f593edd8fa29825f5f
after: https://github.com/dwyl/elixir-auth-google/tree/71c022afee27e2cc377936c686538afa8e08d13e

Todo

before: https://github.com/dwyl/elixir-auth-github/tree/44021233add025348f261f5bf0b9b32fe6c5711a
after: πŸ”œ https://github.com/dwyl/elixir-auth-github/tree/update-docs-issue%2332

@nelsonic
Copy link
Member Author

@nelsonic
Copy link
Member Author

nelsonic commented Feb 1, 2020

Demo App working ...

http://localhost:4000/
image

image
If you are a member of a few orgs, keep scrolling until you see the Authorize nelsonic button:
image

Once you authorize the app, you will be redirected back to the Phoenix App and will see:
image

πŸš€

@nelsonic
Copy link
Member Author

nelsonic commented Feb 1, 2020

image
Auth Step:
image
Success:
image

That was a good day! :shipit:

@nelsonic nelsonic moved this from To do to Awaiting Feedback/Review in Nelson's List Feb 1, 2020
SimonLab added a commit that referenced this issue Feb 4, 2020
Nelson's List automation moved this from Awaiting Feedback/Review to Done Feb 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Nelson's List
  
Done
Development

No branches or pull requests

1 participant