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

Split up the documentation and add provider specific information plus… #139

Merged
merged 4 commits into from Sep 11, 2015

Conversation

@ldesplat
Copy link
Contributor

ldesplat commented Sep 11, 2015

… some more details

  • README.md much like Hapi's
  • General API documentation
    • Added a section on how to use without a strategy
  • Providers documentation
    • What does each provider take as config
    • What does each provider return in their profile information
    • What is the scope that each provider has on by default
@ldesplat

This comment has been minimized.

Copy link
Contributor Author

ldesplat commented Sep 11, 2015

@qualquervalor Does this solve #109 ?

Also satisfies #127

@ldesplat ldesplat added this to the 5.1.1 milestone Sep 11, 2015
@qualquervalor

This comment has been minimized.

Copy link

qualquervalor commented Sep 11, 2015

It looks good, having links to the providers documentation is nice. I would suggest also calling out the endpoints, auth and token details for each provider, in Provider.md

ldesplat added 3 commits Sep 11, 2015
ldesplat added a commit that referenced this pull request Sep 11, 2015
Split up the documentation, add specific provider documentation.
Closes #139 , #109 
Satisfies outmoded/hapi-contrib#49 and outmoded/hapijs.com#227
@ldesplat ldesplat merged commit 69d6714 into hapijs:master Sep 11, 2015
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
This was referenced Sep 11, 2015
@ldesplat ldesplat modified the milestones: 5.2.0, 5.1.1 Sep 24, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.