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 MFA documentation based on WebAuthn integration changes #339

Merged
merged 6 commits into from
Aug 3, 2023

Conversation

jenshenny
Copy link
Member

@jenshenny jenshenny commented Jul 18, 2023

WebAuthn is fully integrated as a 2fa factor. When users register a security device, they will now be provided with recovery codes and be able to configure their multi-factor authentication level without needing to enable time-based MFA.

Changes

  • Moving the MFA level and recovery codes sections to the top level setup MFA page from the setting up OTP page based on these changes. Also revised the sections to include the new behaviour (updating MFA level).
  • Updating the CLI docs to mention that WebAuthn MFA will be prompted based on the user's MFA level.
  • Ensure multi-factor authentication is spelled with the hyphen
  • Ensure proper capitalization of RubyGems.org on changed pages

Testing

Read through these pages to make sure the information is updated and correct

2. You will be prompted to use your MFA device to authorize the MFA level change.
![Multi-factor authentication prompt to update MFA level](/images/changing_mfa_step2.png){:class="t-img"}

## Using recovery codes and re-setup a previously enabled MFA

Choose a reason for hiding this comment

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

Suggested change
## Using recovery codes and re-setup a previously enabled MFA
## Using recovery codes and reconfiguring a previously enabled MFA

still don't love this but I think this is more grammatical?

Copy link
Member Author

Choose a reason for hiding this comment

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

I changed it to Using recovery codes to reconfigure previously enabled MFA

@jenshenny
Copy link
Member Author

@segiddins would you be able to merge this if there isn't anything blocking?

@segiddins
Copy link
Member

Looks like there are conflicts

@jenshenny
Copy link
Member Author

Indeed, it was from merging #338. Should be good now!

@bettymakes
Copy link

Doc updates LGTM! Looks like conflicts are resolved too. Should be ready for you to merge @segiddins 🙌 . Thanks a bunch!

@segiddins segiddins merged commit dcf4b43 into rubygems:main Aug 3, 2023
1 check passed
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.

5 participants