Doc cleanup largely based on spelling/grammar check #724
Conversation
google-cla
bot
added
the
cla: yes
googlebot
added
the
cla: yes
|
Hi @greggles. Thanks for your PR. I'm waiting for a google member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
| @@ -110,15 +109,15 @@ Click the "Create a new signing key version" button. This will _create_ but not | |||
|
|
|||
|  | |||
|
|
|||
| If successful, you will get a message indiciating the new key version that was created. | |||
| If successful, you will get a message indicating the new key version that was created. | |||
There was a problem hiding this comment.
Here to the end of the file are some spelling fixes.
docs/user_guide.md
Outdated
| This will provide a link to set up your account password. | ||
|
|
||
|  | ||
|
|
||
| ### Second factor authentication | ||
|
|
||
| On your next login, you will be given the option to enroll a second factor for authentication (SMS sent to your personal mobile phone). It is highly recommended to enroll the second factor. | ||
| On your next login, you will be given the option to enroll a second factor for authentication (SMS sent to your mobile phone). It is highly recommended to enroll in a second factor. The phone number requires the international prefix (e.g. +1 for USA). |
There was a problem hiding this comment.
I'm not sure if it's appropriate to put in USA specific advice. The overall idea was suggested by a few admins who noted they were confused by this input.
There was a problem hiding this comment.
On double-checking the form it looks like maybe the input widget was improved in a way that makes this change unneccessary. Happy to remove this if you agree.
There was a problem hiding this comment.
Let's remove. We added the nicer widget just this week #702 because this is a known point of confusion
There was a problem hiding this comment.
We could also note that more-than-one second factor can be useful in case the user loses access to their primary device.
|
/approved I'll let @whaught put the lgtm on, looks great though, thank you! |
…small consistency fixups.
|
Cool, now addressed those suggested changes and udpated the summary. Happy to hear any more feedback if there is any. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: greggles, sethvargo The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
As I was reading through these I noticed some spelling issues at the end of the realm_guide. In training with some users, they mentioned it was confusing setting up 2fa due to the need to prefix the phone number with +1 and suggested adding a note about that to the docs. I also ran the 2 files through grammarly and accepted most of the suggestions. Some items felt like personal preference not worth changing.
Proposed Changes
Release Note
NONE