Skip to content

Add note about new copy and print buttons

Peter Hegman requested to merge docs-update-2fa-recovery-code-docs into master

What does this MR do?

In !49078 (merged) we updated the 2FA recovery codes view to require users to either copy, download, or print codes before being able to proceed. The idea is to hopefully encourage users to save their recovery codes.

This MR adds a note about the new "Copy codes", "Download codes", and "Print codes" buttons.

Screenshots for context

Desktop

Page Before After
Recovery codes Screen_Shot_2020-12-03_at_11.50.21_AM Screen_Shot_2020-12-03_at_11.45.22_AM
Recovery codes - Proceed enabled N/A Screen_Shot_2020-12-03_at_11.47.49_AM
Account after clicking "Proceed" Screen_Shot_2020-12-03_at_11.51.01_AM Screen_Shot_2020-12-03_at_11.45.56_AM

Mobile

Page Before After
Recovery codes Screen_Shot_2020-12-03_at_11.50.39_AM Screen_Shot_2020-12-03_at_11.48.39_AM
Account after clicking "Proceed" Screen_Shot_2020-12-03_at_11.51.18_AM Screen_Shot_2020-12-03_at_11.46.54_AM

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • [-] Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
    • Skipping since this is a small change

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Mike Jang

Merge request reports