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

fix: clean up copy #1515

Merged
merged 14 commits into from
Dec 19, 2022
Merged

fix: clean up copy #1515

merged 14 commits into from
Dec 19, 2022

Conversation

mattrosno
Copy link
Member

@mattrosno mattrosno commented Nov 22, 2022

Content cleanup after reading through primary platform description pages.

Changelog

New

  • N/A

Changed

Home page:

  • Removed mention of inner source, because we don't index IBM internal resources yet
  • Updated descriptions for components, functions, and templates and made them consistent with the schema page descriptions. It was odd how only the component description had an e.g. This also made the description lengths more consistent to prevent widows at common breakpoints.
  • Remove unnecessary use of "library" in the first feature card, because the second feature card didn't include "library"
  • Changed "makers" to "creators" to align with IBM's "Let's Create"
  • Made sure our use of asset type lists was consistent
  • Spelled out "Pattern and Asset Library" near the first place that we use the "PAL" acronym

Schema page:

  • Updated library and asset descriptions
  • Updated asset type descriptions to match what's used in the home page, and so the lengths are more consistent

How Carbon works page:

  • Made anchor link headings more consistent (we don't need "Carbon" in every heading)
  • Removed code formatting of emphasized words. We don't need to emphasize words.
  • Updated definitions to match the above two pages.
  • Added more specificity to who maintains the platform, as we specifically state that the system squad maintains a bunch of the libraries.

Library design kits page:

  • No need to link out to designer getting started here. We don't link to developer getting started pages elsewhere in a library. Plus, when a library is referenced in local systems, those local systems might have more specific getting started pages for their creators, so it doesn't make sense to link out to the core getting started page here.

Removed

  • N/A

Testing / reviewing

Run locally to see the updated pages.

- make descriptions consistent across site
Copy link
Collaborator

@francinelucca francinelucca left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@aagonzales aagonzales left a comment

Choose a reason for hiding this comment

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

This looks good from your goal of streamlining content. I had a few comments and suggestions but not any specific corrections, the biggest one being around the design kit description. I'll go ahead and greenlight it though

services/web-app/pages/about-carbon/how-carbon-works.mdx Outdated Show resolved Hide resolved
services/web-app/pages/about-carbon/how-carbon-works.mdx Outdated Show resolved Hide resolved
services/web-app/pages/about-carbon/how-carbon-works.mdx Outdated Show resolved Hide resolved
services/web-app/pages/about-carbon/how-carbon-works.mdx Outdated Show resolved Hide resolved
services/web-app/pages/index.js Outdated Show resolved Hide resolved
Copy link
Member

@aubrey-oneal aubrey-oneal left a comment

Choose a reason for hiding this comment

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

Overall, this is a great clean up. Thanks Matt!

I left notes on some content I'd like to revert back to, each of which were drafted with stakeholder and user feedback. Namely:

  • Add component examples back in
  • Add examples of Design Kit tools back in
  • Add code tags/highlights back in for the How Carbon Works page.

services/web-app/pages/about-carbon/how-carbon-works.mdx Outdated Show resolved Hide resolved
services/web-app/pages/about-carbon/how-carbon-works.mdx Outdated Show resolved Hide resolved
services/web-app/pages/about-carbon/how-carbon-works.mdx Outdated Show resolved Hide resolved
services/web-app/pages/index.js Outdated Show resolved Hide resolved
@mattrosno
Copy link
Member Author

@carbon-design-system/carbon-platform-designers can I get another review on this?

Copy link
Member

@aagonzales aagonzales left a comment

Choose a reason for hiding this comment

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

Ok it looks good to me!

@carbon-bot
Copy link
Contributor

The commits in this PR will result in the following version changes:

🐛 PATCH release: @carbon-platform/web-app

@sonarcloud
Copy link

sonarcloud bot commented Dec 19, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@mattrosno mattrosno dismissed aubrey-oneal’s stale review December 19, 2022 17:33

I addressed the feedback.

@mattrosno mattrosno merged commit 88d3dd5 into main Dec 19, 2022
@mattrosno mattrosno deleted the content-cleanup branch December 19, 2022 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants