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

Missing documentation for Custom Auth #963

Merged
merged 4 commits into from
Oct 18, 2019
Merged

Missing documentation for Custom Auth #963

merged 4 commits into from
Oct 18, 2019

Conversation

dplewis
Copy link
Member

@dplewis dplewis commented Oct 18, 2019

Closes: #934
Addresses: #552

Adds deprecation for _linkWith and _loginWith

I can check the links works after this PR is merged.

Closes: #934

Adds deprecation for _linkWith and _loginWith
@dplewis dplewis requested review from acinader and TomWFox October 18, 2019 20:45
@codecov
Copy link

codecov bot commented Oct 18, 2019

Codecov Report

Merging #963 into master will decrease coverage by 0.05%.
The diff coverage is 92.85%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #963      +/-   ##
==========================================
- Coverage   91.94%   91.88%   -0.06%     
==========================================
  Files          54       54              
  Lines        5077     5080       +3     
  Branches     1142     1143       +1     
==========================================
  Hits         4668     4668              
- Misses        409      412       +3
Impacted Files Coverage Δ
src/FacebookUtils.js 100% <100%> (ø) ⬆️
src/AnonymousUtils.js 100% <100%> (ø) ⬆️
src/ParseUser.js 82.61% <87.5%> (-0.57%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7ff9f92...d519f0a. Read the comment docs.

@dplewis
Copy link
Member Author

dplewis commented Oct 18, 2019

@rhuanbarreto Anything you want to add?

Copy link
Contributor

@acinader acinader left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there anywhere where a user can find a code example of how to do use an auth adapter? I guess in unit tests -- which is where i figured it out, but i still needed your help :). Would be nice to have a working example somewhere...

@dplewis
Copy link
Member Author

dplewis commented Oct 18, 2019

There is documentation in the guide Custom Authentication Module. There are some missing documentation in it as well like id field in authData is required.

Working code examples are in ParseUserTest and a working server setup here.

@dplewis
Copy link
Member Author

dplewis commented Oct 18, 2019

@acinader Perhaps we should add this to the ReadMe since this highly requested?

Copy link
Contributor

@acinader acinader left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Yes, I think adding a single sentence with a link in this section: https://github.com/parse-community/parse-dashboard#other-configuration-options in the readme would be a good idea.

  2. The guide could use updating to drop the dangling _ (and adding a link to the tests would be a good idea)

this is super nice.

@rhuanbarreto
Copy link

I think that this will help more the people looking for answers and it’s enough for now. I managed to implement the Keycloak login but I’m using the REST API for now. Soon I will try to commit something showing how is it on Server side.

@dplewis
Copy link
Member Author

dplewis commented Oct 18, 2019

@rhuanbarreto Having another set of eyes always helps as we tend to forget new users have to read through the documentation.

If you can try to use linkWith and provide feedback on if these changes are clear. We would greatly appreciate it.

@dplewis dplewis merged commit 38286f2 into master Oct 18, 2019
@dplewis dplewis deleted the auth-docs branch October 18, 2019 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing lot's of documentation in order to create a custom authentication
3 participants