Revise headers and instructions by esgoodman · Pull Request #709 · 18F/identity-idp

esgoodman · 2016-11-08T23:26:11Z

Why: To match our styleguide, to improve the clarity of instructions, and to make a better experience for people using screenreaders

esgoodman · 2016-11-08T23:30:31Z

config/locales/headings/en.yml

    log_in: Sign in
-    log_in_branded: Sign in to continue to %{sp}
-    choose_otp_delivery: Choose delivery method
+    log_in_branded: Sign in to continue to %{sp} #question about variable names -- "_branded" vs _"w_with_SP"?


A couple of questions about variable names.

Does _branded mean the same thing as with_sp?

Would it be possible to change log_in to sign_in to match our styleguide? (Yes, this is nitpicky, I know.)

Seems like a very reasonable change to make, do you need help changing that?

I'm assuming all that's needed is a find-and-replace on log_in. In that case, we have two options:

I can try to change it myself first, and then get help on the PR when I inevitably break something because I haven't written real code for the web since 2003.

Someone else can make the change.

I made the change in 1bba588 and pushed it to this branch

esgoodman · 2016-11-08T23:31:07Z

config/locales/headings/en.yml

      change: Change your password
-      forgot: Forgot password
-      confirm: Confirm your password
+      forgot: Forget your password? #why is this here and not in links/en.yml?


This is used as a link in the UI -- I think. Should it be in links/en.yml?

This is used as both the header on this page: https://idp.demo.login.gov/users/password/new, as well as a link on the home page. If they need to be different, then yes, we should add an entry in the links section. Also, shouldn't this be "Forgot your password?" instead of "Forget your password?".

esgoodman · 2016-11-08T23:32:05Z

config/locales/headings/en.yml

      profile_info_tt: Why can’t I edit my profile information?
      account_history: Account history
-      login_info: Login information
+      login_info: Account information


@jeanninehunter Changed for greater consistency in headers. Also because we decided to use "sign in" and not "log in"...and "Sign-in information" just didn't sound right.

esgoodman · 2016-11-08T23:34:43Z

config/locales/instructions/en.yml

      wrong_number: Entered the wrong phone number? %{link}
      totp_intro_html: >
-        Please enter the code from your authenticator app.
+        Enter the code from your authenticator app.


Removed all the "pleases" as per http://www.ihearttechnicalwriting.com/write-error-messages/. Which maybe @jeanninehunter will disagree with 😨

esgoodman · 2016-11-08T23:38:50Z

config/locales/devise/en.yml

+        That passcode is invalid. You can try entering it again or request a new
        one-time passcode.
-      invalid_recovery_code: Invalid recovery code. Please try again.
+      invalid_recovery_code: That recovery code is invalid.


@monfresh What next steps can we offer a user who (perhaps) had a typo in a recovery code? Obvs we can suggest that the user check that they correctly typed in the code and try again...anything else? Best practices in error message writing say that we should give some next steps.

I can't think of anything else. Here is Apple's support article on the subject for any ideas: https://support.apple.com/en-us/HT202649

esgoodman · 2016-11-08T23:42:31Z

@theresaanna There is a merge conflict with #686. Would love some help resolving!

hursey013 · 2016-11-10T15:24:12Z

@esgoodman which translation string would you like to use?

To protect your account, we will send you a one-time passcode via text message or phone call every time you sign in.

or

Every time you log in, we will send you a one-time passcode via text message or phone call. This helps safeguard your account.

esgoodman · 2016-11-10T16:44:31Z

@hursey013 The one from #686, which I believe is the second one.

**Why**: To match the styleguide and for better clarity

**Why**: Make the key names consistent with the language **How**: ``` git grep -l log_in_ | xargs perl -p -i -e 's/log_in_/sign_in_/g' -- ```

**Why**: Resolved issues caused by updated translation strings

hursey013 · 2016-11-11T03:10:17Z

@esgoodman - tests are passing now, let me know if theres's anything else i can help with

monfresh · 2016-11-14T21:18:50Z

config/locales/headings/en.yml

-      security_practices: Our Security Practices
-      privacy_practices: Our Privacy Practices
+      security_practices: Our Security Practices #should this be in sentence case?
+      privacy_practices: Our Privacy Practices #should this be in sentence case?


Can we address these questions in this PR? Who is/are the person(s) to answer this?

@jeanninehunter will address when she has finished dealing with ATO documentation.

**Why**: To match our styleguide.

esgoodman · 2016-11-14T23:14:48Z

config/locales/headings/en.yml

-      security_practices: Our Security Practices
-      privacy_practices: Our Privacy Practices
+      privacy_act: Privacy Act statement
+      security_practices: Our security practices 


Resolved as per our styleguide

hursey013 · 2016-11-15T14:36:53Z

@esgoodman since this is largely a content based PR, would you like another person familiar with the content styleguide to review it before merging? Or if you want to give it the thumbs up I can go ahead and merge it in as it.

monfresh · 2016-11-16T16:44:25Z

config/locales/headings/en.yml

    log_in: Sign in
-    log_in_branded: Sign in to continue to %{sp}
-    choose_otp_delivery: Choose delivery method
+    sign_in_branded: Sign in to continue to %{sp} #question about variable names -- "_branded" vs _"w_with_SP"?


For consistency, these should probably be sign_in_with_sp and sign_in_without_sp.

@monfresh I really want to close this PR -- file and issue ad do a pass at this later?

Sounds good. I was just responding to your comment on line 13.

monfresh

lgtm. will open new issues for remaining work.

**Why**: * Few unfinished items **What**: * Make "with sp" and "without sp" locales consistent with others * "Forget your password?" -> "Forgot your password?" * Use smartquotes everywhere

* Revise headers and instructions **Why**: To match the styleguide and for better clarity * Rename log_in keys to sign_in **Why**: Make the key names consistent with the language **How**: ``` git grep -l log_in_ | xargs perl -p -i -e 's/log_in_/sign_in_/g' -- ``` * Fix broken tests **Why**: Resolved issues caused by updated translation strings * Changes privacy headers to sentence case **Why**: To match our styleguide.

**Why**: * Few unfinished items **What**: * Make "with sp" and "without sp" locales consistent with others * "Forget your password?" -> "Forgot your password?" * Use smartquotes everywhere

* Revise headers and instructions **Why**: To match the styleguide and for better clarity * Rename log_in keys to sign_in **Why**: Make the key names consistent with the language **How**: ``` git grep -l log_in_ | xargs perl -p -i -e 's/log_in_/sign_in_/g' -- ``` * Fix broken tests **Why**: Resolved issues caused by updated translation strings * Changes privacy headers to sentence case **Why**: To match our styleguide.

**Why**: * Few unfinished items **What**: * Make "with sp" and "without sp" locales consistent with others * "Forget your password?" -> "Forgot your password?" * Use smartquotes everywhere

esgoodman added the status - work in progress label Nov 8, 2016

esgoodman commented Nov 8, 2016

View reviewed changes

esgoodman added status - help wanted status - ready for review and removed status - work in progress status - ready for review labels Nov 8, 2016

esgoodman assigned theresaanna and unassigned theresaanna Nov 9, 2016

Revise headers and instructions

e20c295

**Why**: To match the styleguide and for better clarity

hursey013 force-pushed the liz/revise-headers-instructions branch from 5b3982c to e20c295 Compare November 10, 2016 17:42

Rename log_in keys to sign_in

1bba588

**Why**: Make the key names consistent with the language **How**: ``` git grep -l log_in_ | xargs perl -p -i -e 's/log_in_/sign_in_/g' -- ```

esgoodman added status - ready for review status - work in progress and removed status - help wanted status - ready for review labels Nov 10, 2016

esgoodman assigned hursey013 Nov 10, 2016

Fix broken tests

095f1c8

**Why**: Resolved issues caused by updated translation strings

hursey013 added status - ready for review and removed status - work in progress labels Nov 11, 2016

monfresh reviewed Nov 14, 2016

View reviewed changes

hursey013 removed their assignment Nov 14, 2016

Changes privacy headers to sentence case

ec31c77

**Why**: To match our styleguide.

esgoodman commented Nov 14, 2016

View reviewed changes

monfresh reviewed Nov 16, 2016

View reviewed changes

monfresh approved these changes Nov 17, 2016

View reviewed changes

monfresh merged commit 2d0bfdf into master Nov 17, 2016

monfresh deleted the liz/revise-headers-instructions branch November 17, 2016 22:18

Conversation

esgoodman commented Nov 8, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zachmargolis Nov 10, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

esgoodman Nov 8, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

esgoodman commented Nov 8, 2016

Uh oh!

hursey013 commented Nov 10, 2016

Uh oh!

esgoodman commented Nov 10, 2016

Uh oh!

hursey013 commented Nov 11, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hursey013 commented Nov 15, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

monfresh left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

zachmargolis Nov 10, 2016 •

edited

Loading

esgoodman Nov 8, 2016 •

edited

Loading