Skip to content

Docs: Add more info on recovery codes

Tristan requested to merge docs-update-2fa into master

What does this MR do?

This MR adds a bit more detail to our documentation on two-factor authentication specifically around recovery codes. It includes the specific name of the file when recovery codes are downloaded along with a screenshot of what the recovery code screen looks like. The codes displayed are from an account that's already been deleted.

Related issues

#195 - A user recently left feedback that indicated it would have been helpful for our documentation to include the file name for recovery codes when they're downloaded.

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

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.

2. Technical Writer

  • Optional: 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.

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 and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Tristan

Merge request reports