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.

Sign up for GitHub

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

Jump to bottom

Updates-to-community-API-key-pattern #1599

Merged
merged 6 commits into from
Aug 27, 2020
Merged

Updates-to-community-API-key-pattern #1599

merged 6 commits into from
Aug 27, 2020

Conversation

chloepoulterdesign
Copy link
Contributor

@chloepoulterdesign chloepoulterdesign commented Aug 21, 2020 •
edited
Loading

Closes https://github.ibm.com/CDAI-design/pal/issues/263

As part of merging security's Generate an API key pattern with the Carbon Community (CDAI) pattern, we need to make some changes to the documentation.

Many thanks to Shelley Dignum for auditing the patterns.
FYI @vikkipaterson and @Levinson1

Changelog

New

  • section explaining the variety of warnings about API key retrieval that should be provided to users
  • section explaining the order that restricted access options should be included in the modal
  • section on a full-page API key management page
  • section on editing API keys
  • guidance that the generated key should appear in its' own modal view, not in the same view as the options form, as the key is the output of a "generation" action which happens after a user has specified the options they desire

Changed

  • Images in the "Name the API key" section to remove the (confusing) progress indicator

Removed

  • Image containing the destination selector in the "Name the API key" section to avoid confusion with the restricted access section

@vercel
Copy link

vercel bot commented Aug 21, 2020 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/carbon-design-system/carbondesignsystem/ok19ob5tq
✅ Preview: https://carbondesignsy-git-fork-chloepoulterdesign-updates-to-co-bc5e8f.carbon-design-system.vercel.app

@vikkipaterson
Copy link
Contributor

This looks great to me Chloe :) Only comment I have is why are these items number 6,7,8 - where is 1-5?
image

@chloepoulterdesign chloepoulterdesign marked this pull request as ready for review August 25, 2020 13:31
@chloepoulterdesign chloepoulterdesign requested a review from a team as a code owner August 25, 2020 13:31
@chloepoulterdesign
Copy link
Contributor Author

Good spot Vikki! That's so weird - and when I build locally, it renders 1,2,3!
image
The numbers are generated when the site is built, so I assume it's an error with Vercel's deployment, and when it's actually pushed live this wouldn't be an issue.
Can anyone from Carbon confirm that the numbers will appear correctly when this is merged?

emyarod
emyarod approved these changes Aug 25, 2020
View reviewed changes
Copy link
Member

@emyarod emyarod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the numbering looks correct to me

image

@tw15egan tw15egan requested review from a team and jillianhowarth and removed request for a team August 25, 2020 16:32
jillianhowarth
jillianhowarth suggested changes Aug 26, 2020
View reviewed changes
Copy link
Contributor

@jillianhowarth jillianhowarth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple minor fixes but otherwise this looks great @chloepoulterdesign!

src/pages/community/patterns/generate-an-api-key/index.mdx Outdated Show resolved Hide resolved
src/pages/community/patterns/generate-an-api-key/index.mdx Outdated Show resolved Hide resolved
src/pages/community/patterns/generate-an-api-key/index.mdx Outdated Show resolved Hide resolved
@chloepoulterdesign @jillianhowarth
Apply suggestions from code review
45f9d1c 
Thanks @jillianhowarth!

Co-authored-by: jillianhowarth <jillianlovesdogs@gmail.com>
@vercel vercel bot temporarily deployed to Preview August 27, 2020 18:22 Inactive
@kodiakhq kodiakhq bot merged commit c8f576f into carbon-design-system:master Aug 27, 2020
@chloepoulterdesign chloepoulterdesign deleted the Updates-to-community-API-key-pattern branch September 9, 2020 12:23
natashadecoste pushed a commit to natashadecoste/carbon-website that referenced this pull request May 19, 2021
@chloepoulterdesign @jillianhowarth
@tw15egan @kodiakhq @natashadecoste
Updates-to-community-API-key-pattern (carbon-design-system#1599)
fb3cce5 
* Updates-to-community-API-key-pattern

* Apply suggestions from code review

Thanks @jillianhowarth!

Co-authored-by: jillianhowarth <jillianlovesdogs@gmail.com>

* chore(content): Use consistent capitalization

Co-authored-by: jillianhowarth <jillianlovesdogs@gmail.com>
Co-authored-by: TJ Egan <tw15egan@gmail.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
natashadecoste pushed a commit to natashadecoste/carbon-website that referenced this pull request May 19, 2021
@chloepoulterdesign @jillianhowarth
@tw15egan @kodiakhq @natashadecoste
Updates-to-community-API-key-pattern (carbon-design-system#1599)
e0744a3 
* Updates-to-community-API-key-pattern

* Apply suggestions from code review

Thanks @jillianhowarth!

Co-authored-by: jillianhowarth <jillianlovesdogs@gmail.com>

* chore(content): Use consistent capitalization

Co-authored-by: jillianhowarth <jillianlovesdogs@gmail.com>
Co-authored-by: TJ Egan <tw15egan@gmail.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emyarod emyarod emyarod approved these changes

@tw15egan tw15egan tw15egan approved these changes

@jillianhowarth jillianhowarth jillianhowarth approved these changes

@joshblack joshblack Awaiting requested review from joshblack

Assignees
No one assigned
Labels
status: ready to merge 🎉
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@chloepoulterdesign @vikkipaterson @emyarod @tw15egan @jillianhowarth