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

[UI Content Design Guild] Modal component topic is missing content #4234

Open
lesnider opened this issue Sep 2, 2024 · 5 comments
Open

[UI Content Design Guild] Modal component topic is missing content #4234

lesnider opened this issue Sep 2, 2024 · 5 comments

Comments

@lesnider
Copy link
Contributor

lesnider commented Sep 2, 2024

https://carbondesignsystem.com/components/modal/usage/

Need explicit guidance for creating content for modals.

@lesnider
Copy link
Contributor Author

lesnider commented Sep 2, 2024

@sstrubberg @laurenmrice @aagonzales
Hey, Scott, Lauren, and Anna. Here's most of our feedback for the Modal component, which we want to go through with you and other CDSers on Tuesday.
Modal-UIContentGuild-comments+edits.docx

@lesnider lesnider changed the title [UI Content Design Guild] Modal component topic is missing content #4165 [UI Content Design Guild] Modal component topic is missing content Sep 2, 2024
@laurenmrice laurenmrice moved this to 🪆 Needs Refined in Design System Sep 16, 2024
@laurenmrice
Copy link
Member

Issue refinement

  • I went through the attached document above. I made some comments in it here:

  • Most changes mentioned in the document are doable as part of this issue and I would size it as an 8. However there were a couple things that would need to be addressed in a separate issue, which I will list below.


Separate issue

A separate issue would need to be created to tackle the following:

1. Live demo changes

  • List items should be in sentence-style capitalization

We would need to connect with dev to make sure we could alter the text of these react stories that show up in the live demo dropdown, since the names would then be different than the ones on the actual storybook. I think it is probably doable though.

  • Live demo modal example content changes that appear in each story.

All of the Live demo modal example content changes need to be addressed in a dev issue in the carbon repo to fix this in the storybook first, and then it will fix the live demo on the website. It would be good to have all of the content that you would want to change in each of the examples finalized before posting them in the dev issue. The changes to the story names in the live demo dropdown could also be addressed in this same issue.

@laurenmrice laurenmrice moved this from 🪆 Needs Refined to ⏱ Backlog in Design System Sep 17, 2024
@scanlana
Copy link
Contributor

Here is the updated Word doc that will be used to make changes to the Modal component.

Modal-UIContentGuild-comments+edits3.docx

@scanlana
Copy link
Contributor

Made additional small changes where appropriate and added them to this Word doc.
Modal-UIContentGuild-comments+edits4.docx

scanlana added a commit to scanlana/carbon-website that referenced this issue Oct 31, 2024
Updated content as outlined in this issue:
carbon-design-system#4234
@scanlana
Copy link
Contributor

Updated the Modal component page in my own fork and created a pull request:
#4345

emyarod pushed a commit to scanlana/carbon-website that referenced this issue Nov 13, 2024
Updated content as outlined in this issue:
carbon-design-system#4234
kodiakhq bot pushed a commit that referenced this issue Nov 13, 2024
* Update usage.mdx

Updated content as outlined in this issue:
#4234

* Update src/pages/components/modal/usage.mdx

Fixing my overzealous application of IBM Style :)

Co-authored-by: Anna Gonzales <[email protected]>

* Update src/pages/components/modal/usage.mdx

Co-authored-by: Anna Gonzales <[email protected]>

* Update src/pages/components/modal/usage.mdx

Co-authored-by: Anna Gonzales <[email protected]>

* Update usage.mdx

Addressing comments from the pull request.

* chore: format

---------

Co-authored-by: Anna Gonzales <[email protected]>
Co-authored-by: emyarod <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: ⏱ Backlog
Development

No branches or pull requests

6 participants
@scanlana @laurenmrice @lesnider @Kritvi-bhatia17 @alina-jacob and others