docs(elements): update images and summaries #1007

eyevana · 2023-05-30T19:39:59Z

Closes #1008

What I did

Updated all the images and summaries for the /elements landing page according to the design spec
Modified the example shortcode to allow for absolute paths in its image src

Testing Instructions

Review the linked spec and verify that it matches the deploy preview

Notes to Reviewers

changeset-bot · 2023-05-30T19:40:02Z

⚠️ No Changeset found

Latest commit: ca0b83c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

netlify · 2023-05-30T19:40:05Z

✅ Deploy Preview for red-hat-design-system ready!

Name	Link
🔨 Latest commit	`ca0b83c`
🔍 Latest deploy log	https://app.netlify.com/sites/red-hat-design-system/deploys/647dfeef10ea120008481091
😎 Deploy Preview	https://deploy-preview-1007--red-hat-design-system.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

github-actions · 2023-05-30T19:42:23Z

Size Change: +116 B (0%)

Total Size: 188 kB

Filename	Size	Change
`./elements/rh-accordion/rh-accordion.js`	1.17 kB	+1 B (0%)
`./elements/rh-badge/rh-badge.js`	922 B	+3 B (0%)
`./elements/rh-blockquote/rh-blockquote.js`	1.96 kB	+2 B (0%)
`./elements/rh-button/rh-button.js`	3.77 kB	+1 B (0%)
`./elements/rh-card/rh-card.js`	1.96 kB	-1 B (0%)
`./elements/rh-cta/rh-cta.js`	3.75 kB	-4 B (0%)
`./elements/rh-dialog/rh-dialog.js`	1.66 kB	+16 B (+1%)
`./elements/rh-navigation-secondary/rh-navigation-secondary.js`	4.83 kB	+14 B (0%)
`./elements/rh-pagination/rh-pagination.js`	4.46 kB	+13 B (0%)
`./elements/rh-spinner/rh-spinner.js`	1.6 kB	+37 B (+2%)
`./elements/rh-stat/rh-stat.js`	2.31 kB	+6 B (0%)
`./elements/rh-subnav/rh-subnav.js`	2.81 kB	+37 B (+1%)
`./elements/rh-tabs/rh-tabs.js`	1.6 kB	-4 B (0%)
`./elements/rh-tag/rh-tag.js`	1.89 kB	-5 B (0%)

ℹ️ View Unchanged

Filename	Size
`./elements/rh-accordion/rh-accordion-header.js`	1.98 kB
`./elements/rh-accordion/rh-accordion-panel.js`	1.24 kB
`./elements/rh-alert/rh-alert.js`	4.25 kB
`./elements/rh-avatar/random-pattern-controller.js`	2.72 kB
`./elements/rh-avatar/rh-avatar.js`	26.6 kB
`./elements/rh-context-provider/rh-context-provider.js`	749 B
`./elements/rh-dialog/yt-api.js`	614 B
`./elements/rh-footer/rh-footer-block.js`	765 B
`./elements/rh-footer/rh-footer-copyright.js`	362 B
`./elements/rh-footer/rh-footer-links.js`	1.06 kB
`./elements/rh-footer/rh-footer-social-link.js`	960 B
`./elements/rh-footer/rh-footer-universal.js`	4.07 kB
`./elements/rh-footer/rh-footer.js`	5.07 kB
`./elements/rh-footer/rh-global-footer.js`	250 B
`./elements/rh-navigation-secondary/rh-navigation-secondary-dropdown.js`	2.42 kB
`./elements/rh-navigation-secondary/rh-navigation-secondary-menu-section.js`	1.47 kB
`./elements/rh-navigation-secondary/rh-navigation-secondary-menu.js`	1.74 kB
`./elements/rh-navigation-secondary/rh-navigation-secondary-overlay.js`	571 B
`./elements/rh-navigation-secondary/test/fixtures.js`	851 B
`./elements/rh-tabs/rh-tab-panel.js`	697 B
`./elements/rh-tabs/rh-tab.js`	1.45 kB
`./elements/rh-tooltip/rh-tooltip.js`	1.16 kB
`./lib/context/color/consumer.js`	1.15 kB
`./lib/context/color/controller.js`	1.11 kB
`./lib/context/color/provider.js`	2 kB
`./lib/context/event.js`	598 B
`./lib/DirController.js`	488 B
`./lib/functions.js`	175 B
`./lib/ScreenSizeController.js`	856 B
`./rhds.min.js`	85.4 kB

_{compressed-size-action}

nikkimk

Looking good so far with a couple changes on the DP:

Elements should be sorted by and alias not tagName
Elements should be displaying alias not tagName ("Cta" should be "Call to Action", "Stat" should be "Statistic", etc.)
Card's summary does not match the Doc
Pagination has no summary displaying
Foundations section at the bottom should be replaced with Patterns

eyevana · 2023-05-31T13:32:12Z

@nikkimk Thanks for the review. I think I've addressed all the issues you identified. Can you take another looksy, pleaseee? <3

elements/rh-pagination/rh-pagination.ts

coreyvickery · 2023-06-01T08:51:43Z

@eyevana Some very small edits:

Add Breadcrumb (coming soon) card and thumbnail, but do not link it anywhere
Remove the gray border around the Dialog card
Add Footnote (coming soon) card and thumbnail, but do not link it anywhere
Change Navigation primary to Navigation (primary)
Change Subnav to Subnavigation
Change the text under the Make a request heading to:

To request a new element or if updates need to be made to an existing element, create a GitHub issue.

The link above should open a new tab or window.

coreyvickery · 2023-06-01T21:11:03Z

@eyevana Hey, I do not see the (coming soon) element cards and text as described in my comment above.

eyevana · 2023-06-01T23:14:19Z

@coreyvickery yep, I'm working on that last piece now. I'll ping you here when it's ready for another round of reviews.

eyevana · 2023-06-02T00:33:04Z

@coreyvickery I added Breadcrumb and Footnote to /elements as coming soon. Do you also want me to include them in the side nav? For example, "Breadcrumb (coming soon)" with no link?

coreyvickery · 2023-06-02T00:34:18Z

@coreyvickery I added Breadcrumb and Footnote to /elements as coming soon. Do you also want me to include them in the side nav? For example, "Breadcrumb (coming soon)" with no link?

@eyevana No thanks.

eyevana · 2023-06-02T00:39:05Z

@bennypowers @nikkimk can you take a look at how I handled the "coming soon" elements and let me know what you think? I stubbed them under the /elements directory so they could be included and sorted under the elementDocs collection, and then I just added some conditional logic in the templates to concatenate the title with "(coming soon)".

coreyvickery · 2023-06-02T19:34:53Z

@eyevana Sorry, I forgot to mention that we are removing Subnavigation for now.

eyevana · 2023-06-03T14:52:19Z

@coreyvickery exclude Subnavigation completely or just mark it as coming soon?

coreyvickery · 2023-06-03T18:37:29Z

@eyevana Yes, kill it. Or create a new issue to kill it website-wide.

eyevana · 2023-06-05T12:51:23Z

@coreyvickery ready for you 👁️ ❤️

nikkimk

lgtm

eyevana · 2023-06-05T12:52:59Z

@nikkimk thank you!

eyevana · 2023-06-05T13:42:47Z

@coreyvickery I'm reverting the change where I remove subnav from the docs. We were chatting about removing subnav during office hours, and the team agrees we should keep it since it's still in use. Steven already broke it out into an issue #1029.

This reverts commit 3f35bcf.

bennypowers

pls move images back to elements/*/docs/screenshot.png, as they can be used on other listings, not only on ux-dot

bennypowers · 2023-06-05T15:20:54Z

@eyevana looks like there are still some conflicts to resolve

eyevana · 2023-06-05T15:24:35Z

@eyevana looks like there are still some conflicts to resolve

Done! :)

eyevana · 2023-06-05T15:27:28Z

@eyevana looks like there are still some conflicts to resolve

Done! :)

Actually need to make one more change

eyevana added 2 commits May 30, 2023 15:20

feat: update all screenshots for /elements

4987153

docs: update element summaries

0d43b08

nikkimk self-requested a review May 30, 2023 19:43

nikkimk requested changes May 30, 2023

View reviewed changes

eyevana added 5 commits May 30, 2023 16:01

docs: update subnav summary

83ec5d1

fix: missed pagination summary

c5ae2c4

fix: card summary coming from JSDoc

0d70a96

docs: update feedback snippet

2986cd8

fix: filter should first try to return alias

231fdbd

fix: linting errors

32c025d

bennypowers reviewed May 31, 2023

View reviewed changes

elements/rh-pagination/rh-pagination.ts Outdated Show resolved Hide resolved

Merge branch 'main' into docs/elements

f629881

bennypowers added the docs Improvements or additions to documentation label Jun 1, 2023

eyevana added 5 commits June 1, 2023 08:56

feat: add alias for subnav

0d0963b

style: remove border from gray bg example

3937f50

chore: rename asset

b3bdcb9

feat: update make a request verbiage

788d323

fix: account for elements that don't have a docsPage

008abe0

eyevana added 2 commits June 1, 2023 20:21

feat: include coming soon items

d32183b

Merge branch 'main' into docs/elements

a9c0523

eyevana requested review from nikkimk and bennypowers June 2, 2023 00:39

Merge branch 'main' into docs/elements

75cdb51

docs: remove subnavigation from docs site

3f35bcf

Merge branch 'main' into docs/elements

1d1602d

nikkimk approved these changes Jun 5, 2023

View reviewed changes

Revert "docs: remove subnavigation from docs site"

66438ca

This reverts commit 3f35bcf.

bennypowers requested changes Jun 5, 2023

View reviewed changes

refactor: moving screenshots to individual element docs

39ffb2d

bennypowers approved these changes Jun 5, 2023

View reviewed changes

bennypowers enabled auto-merge (squash) June 5, 2023 15:20

Merge branch 'main' into docs/elements

bd80417

Merge branch 'main' into docs/elements

ca0b83c

bennypowers merged commit 40bb42f into main Jun 5, 2023
8 checks passed

bennypowers deleted the docs/elements branch June 5, 2023 15:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(elements): update images and summaries #1007

docs(elements): update images and summaries #1007

eyevana commented May 30, 2023 •

edited

changeset-bot bot commented May 30, 2023 •

edited

netlify bot commented May 30, 2023 •

edited

github-actions bot commented May 30, 2023 •

edited

nikkimk left a comment

eyevana commented May 31, 2023

coreyvickery commented Jun 1, 2023

coreyvickery commented Jun 1, 2023

eyevana commented Jun 1, 2023

eyevana commented Jun 2, 2023

coreyvickery commented Jun 2, 2023

eyevana commented Jun 2, 2023

coreyvickery commented Jun 2, 2023

eyevana commented Jun 3, 2023 •

edited

coreyvickery commented Jun 3, 2023

eyevana commented Jun 5, 2023

nikkimk left a comment

eyevana commented Jun 5, 2023

eyevana commented Jun 5, 2023

bennypowers left a comment

bennypowers commented Jun 5, 2023

eyevana commented Jun 5, 2023

eyevana commented Jun 5, 2023

docs(elements): update images and summaries #1007

docs(elements): update images and summaries #1007

Conversation

eyevana commented May 30, 2023 • edited

What I did

Testing Instructions

Notes to Reviewers

changeset-bot bot commented May 30, 2023 • edited

⚠️ No Changeset found

netlify bot commented May 30, 2023 • edited

✅ Deploy Preview for red-hat-design-system ready!

github-actions bot commented May 30, 2023 • edited

nikkimk left a comment

Choose a reason for hiding this comment

eyevana commented May 31, 2023

coreyvickery commented Jun 1, 2023

coreyvickery commented Jun 1, 2023

eyevana commented Jun 1, 2023

eyevana commented Jun 2, 2023

coreyvickery commented Jun 2, 2023

eyevana commented Jun 2, 2023

coreyvickery commented Jun 2, 2023

eyevana commented Jun 3, 2023 • edited

coreyvickery commented Jun 3, 2023

eyevana commented Jun 5, 2023

nikkimk left a comment

Choose a reason for hiding this comment

eyevana commented Jun 5, 2023

eyevana commented Jun 5, 2023

bennypowers left a comment

Choose a reason for hiding this comment

bennypowers commented Jun 5, 2023

eyevana commented Jun 5, 2023

eyevana commented Jun 5, 2023

eyevana commented May 30, 2023 •

edited

changeset-bot bot commented May 30, 2023 •

edited

netlify bot commented May 30, 2023 •

edited

github-actions bot commented May 30, 2023 •

edited

eyevana commented Jun 3, 2023 •

edited