docs: feedback shortcode #1129

bennypowers · 2023-07-06T11:01:17Z

What I did

make a new feedback short code
use that new shortcode in the feedback include
use that new shortcode on the pages which have feedback divs

Testing Instructions

closes #1117

changeset-bot · 2023-07-06T11:01:20Z

⚠️ No Changeset found

Latest commit: 8d16162

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-07-06T11:01:23Z

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

Name	Link
🔨 Latest commit	`8d16162`
🔍 Latest deploy log	https://app.netlify.com/sites/red-hat-design-system/deploys/64f73d5b4d3d560008aa5ea1
😎 Deploy Preview	https://deploy-preview-1129--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 configuration.

github-actions · 2023-07-06T11:04:13Z

Size Change: 0 B

Total Size: 188 kB

ℹ️ 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-accordion/rh-accordion.js`	1.17 kB
`./elements/rh-alert/rh-alert.js`	4.24 kB
`./elements/rh-audio-player/rh-audio-player-about.js`	1.85 kB
`./elements/rh-audio-player/rh-audio-player-scrolling-text-overflow.js`	1.51 kB
`./elements/rh-audio-player/rh-audio-player-subscribe.js`	1.43 kB
`./elements/rh-audio-player/rh-audio-player.js`	14.2 kB
`./elements/rh-audio-player/rh-cue.js`	2 kB
`./elements/rh-audio-player/rh-transcript.js`	2.94 kB
`./elements/rh-avatar/random-pattern-controller.js`	2.72 kB
`./elements/rh-avatar/rh-avatar.js`	2.88 kB
`./elements/rh-badge/rh-badge.js`	862 B
`./elements/rh-blockquote/rh-blockquote.js`	1.96 kB
`./elements/rh-button/rh-button.js`	3.77 kB
`./elements/rh-card/rh-card.js`	1.9 kB
`./elements/rh-code-block/rh-code-block.js`	1.18 kB
`./elements/rh-context-provider/rh-context-provider.js`	185 B
`./elements/rh-cta/rh-cta.js`	4.04 kB
`./elements/rh-dialog/rh-dialog.js`	1.6 kB
`./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-menu/rh-menu.js`	1.02 kB
`./elements/rh-navigation-secondary/rh-navigation-secondary-dropdown.js`	2.31 kB
`./elements/rh-navigation-secondary/rh-navigation-secondary-menu-section.js`	1.46 kB
`./elements/rh-navigation-secondary/rh-navigation-secondary-menu.js`	1.9 kB
`./elements/rh-navigation-secondary/rh-navigation-secondary-overlay.js`	571 B
`./elements/rh-navigation-secondary/rh-navigation-secondary.js`	4.75 kB
`./elements/rh-navigation-secondary/test/fixtures.js`	851 B
`./elements/rh-pagination/rh-pagination.js`	4.45 kB
`./elements/rh-spinner/rh-spinner.js`	1.51 kB
`./elements/rh-stat/rh-stat.js`	2.24 kB
`./elements/rh-subnav/rh-subnav.js`	2.84 kB
`./elements/rh-tabs/rh-tab-panel.js`	789 B
`./elements/rh-tabs/rh-tab.js`	1.81 kB
`./elements/rh-tabs/rh-tabs.js`	1.86 kB
`./elements/rh-tag/rh-tag.js`	1.73 kB
`./elements/rh-tooltip/rh-tooltip.js`	1.07 kB
`./lib/context/color/consumer.js`	1.15 kB
`./lib/context/color/controller.js`	1.11 kB
`./lib/context/color/provider.js`	1.99 kB
`./lib/context/event.js`	598 B
`./lib/context/headings/consumer.js`	711 B
`./lib/context/headings/controller.js`	1.14 kB
`./lib/context/headings/provider.js`	1.23 kB
`./lib/DirController.js`	569 B
`./lib/elements/rh-context-picker/rh-context-picker.js`	1.16 kB
`./lib/elements/rh-context-provider/rh-context-provider.js`	746 B
`./lib/functions.js`	175 B
`./lib/I18nController.js`	1.38 kB
`./lib/ScreenSizeController.js`	856 B
`./rhds.min.js`	76.8 kB

_{compressed-size-action}

…o docs/feedback-shortcode

brianferry · 2023-07-06T13:29:42Z

@coreyvickery - Is there a correct side for the "Feedback" header to show on? On uxdot right now it seems to go on different sides for different pages?

For instance,

https://ux.redhat.com/about/how-we-build/

(On the left)

https://ux.redhat.com/patterns/

(On the right)

bennypowers · 2023-07-06T13:39:15Z

the switch to feedback on the right was done in patterns recently to match elements but the static content pages hadn't caught up yet, this PR fixes that by putting feedback on the right in all cases

docs/elements/index.md

docs/get-started/icon-libraries.njk

docs/patterns/index.md

docs/release-notes.njk

coreyvickery · 2023-07-06T18:20:05Z

@brianferry Right side is correct. Are we proposing to have the same heading and text across the entire website? Or can we create custom instances for certain sections?

brianferry · 2023-07-07T17:39:46Z

@brianferry Right side is correct. Are we proposing to have the same heading and text across the entire website? Or can we create custom instances for certain sections?

If I get your meaning, the feedback section is the same between all the pages, but the other section (Other resources, patterns, elements, etc.) is something that can be customized between the sections of the website.

coreyvickery · 2023-07-07T18:12:55Z

If I get your meaning, the feedback section is the same between all the pages, but the other section (Other resources, patterns, elements, etc.) is something that can be customized between the sections of the website.

@brianferry Yes, the Feedback section will say one thing and should be the same across all Element pages. The Feedback section can say another thing when used on all Pattern pages. The same goes for other sections; a custom message, but the same on all pages in that section. I hope that makes sense.

brianferry · 2023-07-10T19:06:59Z

If I get your meaning, the feedback section is the same between all the pages, but the other section (Other resources, patterns, elements, etc.) is something that can be customized between the sections of the website.

@brianferry Yes, the Feedback section will say one thing and should be the same across all Element pages. The Feedback section can say another thing when used on all Pattern pages. The same goes for other sections; a custom message, but the same on all pages in that section. I hope that makes sense.

So for this PR we're adding code that will automatically generate the feedback section on any page that uses the shortcode. The feedback section will say

To give feedback about anything on this page, [contact us](https://github.com/RedHat-UX/red-hat-design-system/discussions). which seems fine to put on every page, right? Patterns doesn't need different content here than elements?

coreyvickery · 2023-07-10T21:25:07Z

If I get your meaning, the feedback section is the same between all the pages, but the other section (Other resources, patterns, elements, etc.) is something that can be customized between the sections of the website.

@brianferry Yes, the Feedback section will say one thing and should be the same across all Element pages. The Feedback section can say another thing when used on all Pattern pages. The same goes for other sections; a custom message, but the same on all pages in that section. I hope that makes sense.

So for this PR we're adding code that will automatically generate the feedback section on any page that uses the shortcode. The feedback section will say

To give feedback about anything on this page, [contact us](https://github.com/RedHat-UX/red-hat-design-system/discussions). which seems fine to put on every page, right? Patterns doesn't need different content here than elements?

@brianferry I understand better now. Yes, that is fine to put on every page.

marionnegp

The Feedback section's showing up consistently on the right side of the page for me.

docs: feedback shortcode

9802a38

closes #1117

bennypowers enabled auto-merge (squash) July 6, 2023 11:08

brianferry added 2 commits July 6, 2023 09:28

docs: Adding headers to design code status, how we build

829e321

Merge branch 'main' of github.com:RedHat-UX/red-hat-design-system int…

119ef24

…o docs/feedback-shortcode

brianferry reviewed Jul 6, 2023

View reviewed changes

docs/elements/index.md Show resolved Hide resolved

docs/get-started/icon-libraries.njk Show resolved Hide resolved

docs/patterns/index.md Show resolved Hide resolved

docs/release-notes.njk Outdated Show resolved Hide resolved

markcaron mentioned this pull request Jul 7, 2023

docs: update release notes page #1135

Merged

bennypowers and others added 3 commits July 11, 2023 09:31

Merge branch 'main' into docs/feedback-shortcode

1079dc8

docs: review notes

b6aebbd

Merge branch 'main' into docs/feedback-shortcode

10efccb

bennypowers mentioned this pull request Jul 26, 2023

[docs] Design tokens section docs need review/cleanup #1146

Closed

2 tasks

Merge branch 'main' into docs/feedback-shortcode

3295a28

bennypowers mentioned this pull request Aug 8, 2023

docs: fix partial template #1190

Closed

bennypowers added 2 commits August 9, 2023 09:12

Merge branch 'main' into docs/feedback-shortcode

df2d511

Merge branch 'main' into docs/feedback-shortcode

785bd6d

bennypowers requested a review from marionnegp September 5, 2023 14:38

Merge branch 'main' into docs/feedback-shortcode

8d16162

marionnegp approved these changes Sep 5, 2023

View reviewed changes

bennypowers merged commit f5250c9 into main Sep 6, 2023

bennypowers deleted the docs/feedback-shortcode branch September 6, 2023 08:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: feedback shortcode #1129

docs: feedback shortcode #1129

bennypowers commented Jul 6, 2023 •

edited

Loading

changeset-bot bot commented Jul 6, 2023 •

edited

Loading

netlify bot commented Jul 6, 2023 •

edited

Loading

github-actions bot commented Jul 6, 2023 •

edited

Loading

brianferry commented Jul 6, 2023

bennypowers commented Jul 6, 2023

coreyvickery commented Jul 6, 2023

brianferry commented Jul 7, 2023

coreyvickery commented Jul 7, 2023

brianferry commented Jul 10, 2023

coreyvickery commented Jul 10, 2023 •

edited

Loading

marionnegp left a comment

docs: feedback shortcode #1129

docs: feedback shortcode #1129

Conversation

bennypowers commented Jul 6, 2023 • edited Loading

What I did

Testing Instructions

changeset-bot bot commented Jul 6, 2023 • edited Loading

⚠️ No Changeset found

netlify bot commented Jul 6, 2023 • edited Loading

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

github-actions bot commented Jul 6, 2023 • edited Loading

brianferry commented Jul 6, 2023

bennypowers commented Jul 6, 2023

coreyvickery commented Jul 6, 2023

brianferry commented Jul 7, 2023

coreyvickery commented Jul 7, 2023

brianferry commented Jul 10, 2023

coreyvickery commented Jul 10, 2023 • edited Loading

marionnegp left a comment

Choose a reason for hiding this comment

bennypowers commented Jul 6, 2023 •

edited

Loading

changeset-bot bot commented Jul 6, 2023 •

edited

Loading

netlify bot commented Jul 6, 2023 •

edited

Loading

github-actions bot commented Jul 6, 2023 •

edited

Loading

coreyvickery commented Jul 10, 2023 •

edited

Loading