Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorporate design/UX and feature flag for API key sign up #4363

Closed
10 tasks done
patphongs opened this issue May 19, 2020 · 10 comments · Fixed by #4385
Closed
10 tasks done

Incorporate design/UX and feature flag for API key sign up #4363

patphongs opened this issue May 19, 2020 · 10 comments · Fixed by #4385

Comments

@patphongs
Copy link
Member

patphongs commented May 19, 2020

What we're after:
The vanilla sign up key page prototype has been completed. There is outstanding feedback that needs to be addressed prior to merging the code.

Completion criteria:

  • The sign up key page is under a feature flag
  • The design/UX feedback is incorporated per API key signup page #4359 (comment) (per @JonellaCulmer)
    • We include help text that says to include information where "* Required", but none of the fields include an asterisk. Can you include one where appropriate? Or add more "(optional)" text everywhere else.
    • We need to reduce the size of the header for the sign-up text. Currently, it's the same size and prominence as the page title. Can we reduct the text "Sign up for an API key" to 24px?
    • Can we add a second sentence that explains that users can still use the demo key lower on the page? Not sure how to phrase it. Example: Signing up here does not prevent you from trying out the API below using a DEMO_KEY. For those interested in doing XXX, please sign up for an API key.
  • Incorporate finalized language for API key sign up page
  • [ ] Incorporate finalized language for API key sign up email, also include api.open.fec.gov in the example within the emailmoved to issue Research and modify API key signup email language #4445 by @JonellaCulmer
  • Remove Get an [API key here](https://api.data.gov/signup/) when the feature flag is turned on API key signup page #4359 (comment)
  • Clean up JS per @johnnyporkchops API key signup page #4359 (review) and
  • Clean up comments per @johnnyporkchops API key signup page #4359 (review)
  • Add API_UMBRELLA_SIGNUP_KEY for each environment
@jason-upchurch
Copy link
Contributor

jason-upchurch commented May 28, 2020

Making progress on feature flag (code to check for flag complete under #4359, this issue needs to address cf envars). Then working on remaining changes. Anticipating completion this sprint (12.4)

This was referenced May 29, 2020
@jason-upchurch
Copy link
Contributor

jason-upchurch commented Jun 12, 2020

This ticket is on hold while (unrelated) ticket for loading eregs is being worked:
fecgov/fec-eregs#502. Bumping to Sprint 12.6

@jason-upchurch
Copy link
Contributor

jason-upchurch commented Jun 23, 2020

successfully generated welcome email to include the user's api_key by escaping variable as {{ '{{ api_key }}' }} in swagger-ui.html (thanks to Nick at api.data.gov)

@jason-upchurch
Copy link
Contributor

@JonellaCulmer cc @PaulClark2 @AmyKort @patphongs this issue will likely be completed in innovation sprint due to the prioritization of loading the 2020 eregs.

@jason-upchurch
Copy link
Contributor

@JonellaCulmer how does this welcome email look to you?

Screen Shot 2020-07-01 at 3 01 47 PM

@JonellaCulmer
Copy link
Contributor

JonellaCulmer commented Jul 1, 2020

@jason-upchurch Looks great. I think any API user would know what you mean when you say "pass your key in the URL" so I'll leave that alone, unless we think that "paste" might be better than "pass". But I defer to you on that terminology.

In the last sentence, "When contacting us, please tell us what API you're accessing..." Don't we have just the one API? Or are you looking for something more specific like the endpoint?

Also, wondering where that contact us link is going to? Is it the apiinfo email address?


Not part of this work/possible future task that we don't need to do anything with at this time:
Wondering if incorporating a feedback box on the swagger page is possible. I know we get responses via email but this could be another avenue in the future.

@jason-upchurch
Copy link
Contributor

jason-upchurch commented Jul 1, 2020

@JonellaCulmer thanks for the feedback. I'm glad it looks good! That text gets passed (like a parameter gets "passed") from api.data.gov, so I'm not sure what we readily have control over. I'll contact them about altering the text at the bottom and document my research in this issue.

Would you please open an issue for your suggestion? It seems like a reasonable thing to consider.

[edit: I neglected to address your last question:

Also, wondering where that contact us link is going to? Is it the apiinfo email address?

yes--this goes to [email protected]]

@JonellaCulmer
Copy link
Contributor

@jason-upchurch Oh, you're saying we don't have control over the email where it mentions "When contacting us..."?

@jason-upchurch
Copy link
Contributor

@JonellaCulmer That text gets passed from api.data.gov, so I'm not sure what we readily have control over. I'll contact them about altering the text at the bottom and document my research in this issue!

@jason-upchurch
Copy link
Contributor

per @JonellaCulmer

@jason Upchurch The new research you mentioned (to address my comment about the ‘one API’), doesn’t need to be a blocker to implementing the API key signup page. I’m satisfied with the language as it’s currently showing in the example email (comment: #4363 (comment)) and think we should move forward without any other changes to the email text. If we’re able to make future improvements to the language it can happen under the new ticket, #4445. (edited)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants