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 writing-an-authenticator documentation to a tutorial #635

Open
5 tasks
consideRatio opened this issue Jul 3, 2023 · 0 comments
Open
5 tasks

Update writing-an-authenticator documentation to a tutorial #635

consideRatio opened this issue Jul 3, 2023 · 0 comments

Comments

@consideRatio
Copy link
Member

Currently we have a how-to section called writing-an-authenticator.md accompanied with a python file example-oauthenticator.py

I think we should refactor this like...

  • extract reference docs from example-oauthenticator.py
    It describes a lot of the functions, but that kind of content can make sense to have in the docstrings of the functions we override, so lets see if we can extract things of relevance to the function docstrings.
  • relocate the how-to document to the tutorial section
    The tutorial section is learning oriented, the how-to section is task oriented. I figure this is more learning oriented because we can't reasonably help the user arrive all the way anyhow.
  • let the tutorial rely on this not yet written explanation section: docs: add explanation section on how subclasses override functions called from the non-overridden authenticate function #634
  • let the tutorial rely on linking to reference documentation
  • let the tutorial be something that ties this together rather
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant