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

Added some guidance on how to build custom templates to implementing.rst #696

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Magnie
Copy link

@Magnie Magnie commented Jan 19, 2024

Description

While trying to get WebAuthn to work, I couldn't figure out why the input field was readonly and had to dig into the original pull request to figure out I was missing JS. This just clarifies what is needed in custom templates to maintain functionality.

Motivation and Context

Documentation is lacking any information on how to build the custom templates. The only information available is in the original template: Provide a template named <code>two_factor/_base.html</code> to style this page and remove this message.

How Has This Been Tested?

Just used the Preview option when editing the documentation. Otherwise, no functional changes have been made.

Screenshots (if appropriate):

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • N/A

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

While trying to get WebAuthn to work, I couldn't figure out why the input field was readonly and had to dig into the original pull request to figure out I was missing JS. This just clarifies what is needed in custom templates to maintain functionality.
Copy link

codecov bot commented Feb 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (45cfc13) 95.52% compared to head (e3e0b83) 95.52%.
Report is 14 commits behind head on master.

❗ Current head e3e0b83 differs from pull request most recent head 258052b. Consider uploading reports for the commit 258052b to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #696   +/-   ##
=======================================
  Coverage   95.52%   95.52%           
=======================================
  Files          78       78           
  Lines        3354     3354           
  Branches      377      377           
=======================================
  Hits         3204     3204           
  Misses        119      119           
  Partials       31       31           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/implementing.rst Outdated Show resolved Hide resolved
docs/implementing.rst Outdated Show resolved Hide resolved
docs/implementing.rst Show resolved Hide resolved
docs/implementing.rst Show resolved Hide resolved
Includes more generic wording and improved formatting

Co-authored-by: Sergei Maertens <[email protected]>
@Magnie
Copy link
Author

Magnie commented Feb 6, 2024

@sergei-maertens Thanks for your suggestions. I've committed them.

Though with your changes I noticed the formatting looks a little weird in the preview. Is that intentional? I'm not used to the .rst format, so I don't know if it is just a GitHub preview issue or if it will affect the final output in the docs.

Edit: Ah, never mind. Previewing/testing suggested changes doesn't work super well. I've fixed the formatting for real this time.

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.

2 participants