All: Add Multi-factor authentication guide #10661
Conversation
readme/apps/mfa.md
Outdated
| somewhere safe. Each code can only be used once, but you can generate new codes, | ||
| if necessary, from your profile page. | ||
|
|
||
| ### How to enable MFA |
There was a problem hiding this comment.
All the ### should be ## (since they are not all a sub-section of Recovery codes)
readme/apps/mfa.md
Outdated
| @@ -0,0 +1,59 @@ | |||
| # Multi-factor authentication | |||
|
|
|||
| You can now enable Multi-Factor Authentication (MFA) to your Joplin Account. | |||
There was a problem hiding this comment.
For the whole document, please don't add line breaks in paragraphs. We generally don't rely on soft breaks and I don't know how scripts along the pipeline to build the website are going to handle them. So essentially each paragraph should be on a single line
readme/apps/mfa.md
Outdated
| If you need to make login with your recovery code, when you are prompt to enter | ||
| your authentication code in the login screen you will see a link called | ||
| *Use a recovery code*. In this screen you have a new input field for the recovery | ||
| code. |
There was a problem hiding this comment.
This doc is well written but I wonder if we should aim to make it shorter. Partly because, well, users don't like to read the manual, and partly because it's more to maintain and translate. Have a look at at how it's done for example on Dropbox or OneDrive: https://help.dropbox.com/account-access/enable-two-step-verification https://support.microsoft.com/en-us/account-billing/how-to-use-two-step-verification-with-your-microsoft-account-c7910146-672f-01e9-50a0-93b4585e7eb4
It's essentially click here, then follow the instructions. That means our instructions during the process should be clear enough, so that we can keep the doc here to a minimum.
Also I think any process we describe (click here, click there), should be in bullet points.
I think the section titles you have are fine, just the content should be more concise, or bullet points
|
Thanks for the suggestions, especially about the bullet points, it makes a lot of sense. I also added a new section about what app the user can use, not sure what we might want to recommend. I personally only use Bitwarden, I guess Authy/Google Authenticator are simple enough for most cases if the user doesn't want a password manager |
|
readme/apps/mfa.md
Outdated
|
|
||
| You can now enable Multi-Factor Authentication (MFA) to your Joplin Account. MFA enhances your account security by requiring more than just a password to log in. | ||
|
|
||
| If you can't generate your authentication code because you have lost access to your smartphone, for example, you will need to use one of the recovery codes to log in. |
There was a problem hiding this comment.
Move under "Recovery codes" section
readme/apps/mfa.md
Outdated
|
|
||
| ## Recovery Codes | ||
|
|
||
| When you enable MFA, Joplin Cloud will show you a list of codes, that you should save in somewhere safe. Each code can only be used once, but you can generate new codes, if necessary, from your profile page. |
There was a problem hiding this comment.
Move the "Recovery codes" section after "How to disable MFA"
readme/apps/mfa.md
Outdated
| - Click the link to *Enable Multi-Factor Authentication* | ||
| - Follow the instructions shown in the page | ||
|
|
||
| If successful you should see a notification and a new page with your recovery codes, **remember to save them**. |
There was a problem hiding this comment.
That line can be removed as we already say that in the Recovery codes section
readme/apps/mfa.md
Outdated
|
|
||
| - [Access your profile](https://joplincloud.com/users/me) | ||
| - Find the *Multi-factor authentication* section | ||
| - Click the link to *Recovery Codes* |
There was a problem hiding this comment.
How is the link called? We should put the name as the grammar is not right here
There was a problem hiding this comment.
I'm not sure if I understand your suggestion.
There was a problem hiding this comment.
@laurent22 I'm not sure what change is needed here, can you help me?
readme/apps/mfa.md
Outdated
|
|
||
| - [Access your profile](https://joplincloud.com/users/me) | ||
| - Find the *Multi-factor authentication* section | ||
| - Click the link to *Recovery Codes* |
Co-authored-by: Laurent Cozic <[email protected]>
|
For some reason GitHub won't let me merge it from here, so I've pulled it locally in 5f34a1b |
I'm adding a new markdown file with the information about MFA, recovery codes, how to enable, disable and how to make a login with the recovery code.