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

docs: updated component max character / max word counts #1184

Merged
merged 26 commits into from
Nov 27, 2023

Conversation

nikkimk
Copy link
Collaborator

@nikkimk nikkimk commented Aug 2, 2023

What I did

Worked with @coreyvickery to determine which components/parts of components should max character counts in the guidelines pages of docs, and added to or updated docs accordingly:

  • Accordion (title was updated, panel doesn't need a max count)
  • Alert (already exists)
  • Announcement
  • Audio player (already exists for title and description, not needed elsewhere)
  • Avatar (does not need max count)
  • Badge (already exists)
  • Blockquote (does not need max count)
  • Button (already exists)
  • Call to action (already exists)
  • Card (does not need max count)
  • Code block (does not need max count)
  • Dialog (already exists)
  • Disclosure
  • Footer (does not need max count)
  • Jump links
  • Navigation, primary
  • Navigation, secondary (already exists)
  • Link(s)
  • Pagination (does not need max count)
  • Popover (already exists)
  • Progress steps
  • Promo
  • Spinner (already exists)
  • Statistic (already exists)
  • Sticky banner
  • Sticky card
  • Subnav (already exists)
  • Tabs (already exists)
  • Tag (already exists)
  • Tile
  • Tooltip

Testing Instructions

  1. From the DP, verify that each guidelines page has max character / word counts, if applicable.

Notes to Reviewers

  • This is a work in progress.
  • We determined that some components or parts of components did not require a max count.

@nikkimk nikkimk linked an issue Aug 2, 2023 that may be closed by this pull request
19 tasks
@changeset-bot
Copy link

changeset-bot bot commented Aug 2, 2023

⚠️ No Changeset found

Latest commit: d661947

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
Copy link

netlify bot commented Aug 2, 2023

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

Name Link
🔨 Latest commit d661947
🔍 Latest deploy log https://app.netlify.com/sites/red-hat-design-system/deploys/6564b4ccab5b1000080a49ba
😎 Deploy Preview https://deploy-preview-1184--red-hat-design-system.netlify.app
📱 Preview on mobile
Toggle QR Code...

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
Copy link
Contributor

github-actions bot commented Aug 2, 2023

Size Change: 0 B

Total Size: 210 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.27 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.91 kB
./elements/rh-badge/rh-badge.js 1.01 kB
./elements/rh-blockquote/rh-blockquote.js 1.96 kB
./elements/rh-button/rh-button.js 4.39 kB
./elements/rh-card/rh-card.js 1.94 kB
./elements/rh-code-block/rh-code-block.js 1.19 kB
./elements/rh-context-provider/rh-context-provider.js 189 B
./elements/rh-cta/rh-cta.js 4.58 kB
./elements/rh-dialog/rh-dialog.js 1.64 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.18 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.08 kB
./elements/rh-footer/rh-global-footer.js 250 B
./elements/rh-menu/rh-menu.js 1.25 kB
./elements/rh-navigation-secondary/rh-navigation-secondary-dropdown.js 2.57 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 5.41 kB
./elements/rh-navigation-secondary/test/fixtures.js 851 B
./elements/rh-pagination/rh-pagination.js 4.46 kB
./elements/rh-spinner/rh-spinner.js 1.61 kB
./elements/rh-stat/rh-stat.js 2.24 kB
./elements/rh-subnav/rh-subnav.js 2.84 kB
./elements/rh-table/rh-sort-button.js 1.31 kB
./elements/rh-table/rh-table.js 2.29 kB
./elements/rh-tabs/rh-tab-panel.js 789 B
./elements/rh-tabs/rh-tab.js 1.83 kB
./elements/rh-tabs/rh-tabs.js 1.86 kB
./elements/rh-tag/rh-tag.js 1.96 kB
./elements/rh-tile/rh-tile-group.js 1.76 kB
./elements/rh-tile/rh-tile.js 4.2 kB
./elements/rh-timestamp/rh-timestamp.js 974 B
./elements/rh-tooltip/rh-tooltip.js 2.24 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-demo/rh-context-demo.js 1.14 kB
./lib/elements/rh-context-picker/rh-context-picker.js 2.41 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 82 kB

compressed-size-action

@nikkimk nikkimk added the docs Improvements or additions to documentation label Aug 2, 2023
Copy link
Member

@bennypowers bennypowers left a comment

Choose a reason for hiding this comment

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

i think these tables need a sentence or two of prose before them to explain what they're all about

@nikkimk nikkimk marked this pull request as ready for review September 21, 2023 14:28
@nikkimk
Copy link
Collaborator Author

nikkimk commented Sep 21, 2023

@bennypowers there should be text preceding all of the tables. Some of it existed before this PR. PTAL

@nikkimk nikkimk marked this pull request as draft November 10, 2023 21:03
@nikkimk nikkimk requested a review from marionnegp November 10, 2023 21:04
@nikkimk nikkimk marked this pull request as ready for review November 13, 2023 16:43
Copy link
Collaborator

@marionnegp marionnegp left a comment

Choose a reason for hiding this comment

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

Can we say, "The recommended maximum character count..."?

Also in a caption under each table, can it say, "The character count includes spaces"? (I don't think the <rh-tile> page needs this though, since it says basically the same thing above the table.)

docs/patterns/disclosure/index.md Outdated Show resolved Hide resolved
elements/rh-dialog/docs/20-guidelines.md Outdated Show resolved Hide resolved
elements/rh-jump-links/docs/20-guidelines.md Outdated Show resolved Hide resolved
elements/rh-subnav/docs/20-guidelines.md Outdated Show resolved Hide resolved
elements/rh-tag/docs/20-guidelines.md Show resolved Hide resolved
elements/rh-tile/docs/20-guidelines.md Show resolved Hide resolved
@nikkimk
Copy link
Collaborator Author

nikkimk commented Nov 13, 2023

@marionnegp ptal

@nikkimk nikkimk requested a review from marionnegp November 13, 2023 21:32
Copy link
Collaborator

@marionnegp marionnegp left a comment

Choose a reason for hiding this comment

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

Changes are looking good!

  • Didn't notice this last time, but on Audio Player's page, the first column header is "Tab count." Is that right?
  • Do you think it's valuable to add a sentence about how the character count includes spaces? I was thinking it could be a caption under the tables.

@nikkimk nikkimk requested a review from marionnegp November 14, 2023 13:55
@nikkimk
Copy link
Collaborator Author

nikkimk commented Nov 14, 2023

@marionnegp ptal

Copy link
Collaborator

@marionnegp marionnegp left a comment

Choose a reason for hiding this comment

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

Local Grandma Tramples Musician

@markcaron markcaron enabled auto-merge (squash) November 27, 2023 15:24
@markcaron markcaron merged commit 90c0ca4 into main Nov 27, 2023
7 checks passed
@markcaron markcaron deleted the docs/max-character-limits branch November 27, 2023 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Status: Done ☑️
Development

Successfully merging this pull request may close these issues.

[epic][docs] Consider adding max character limits for all components
4 participants