carbon-design-system / carbon-platform

The "next" version of the Carbon Design System website, as a platform.
https://next.carbondesignsystem.com
Apache License 2.0
21 stars 5 forks source link

Move external docs link to secondary button #1050

Closed mattrosno closed 2 years ago

mattrosno commented 2 years ago

Redline: https://www.figma.com/file/vtmHnw9ACgnksFg7ZvEsZC/Component_asset_page_redline?node-id=0%3A1

For both the library and asset dashboards, if the library or asset has externalDocsUrl:

See red highlight:

image
mattrosno commented 2 years ago

@kingtraceyj please review. Are you cool with "View external docs" instead of "View library docs" and "View asset docs"? This is coming from the externalDocsUrl schema key; we currently call this "external" in the link; it'd be nice to keep it saying "external" so library and asset maintainers know how that link it set in the schema.

mattrosno commented 2 years ago

Hey team! Please add your planning poker estimate with ZenHub @andreancardona @francinelucca @jdharvey-ibm

kingtraceyj commented 2 years ago

@mattrosno "View external docs" is fine. Where would the "View library docs" link to? The PAL docs?

mattrosno commented 2 years ago

@kingtraceyj yes, we use external docs to link to the PAL sites, to JSDoc sites, etc. Over time, as we index more docs content, we'll be able to remove the external docs button for most libraries and assets.

kingtraceyj commented 2 years ago

Yeah. Then I think "View library docs" makes the most sense as well.

mattrosno commented 2 years ago

@kingtraceyj okay, I updated the task to:

Button should say "View library docs" and "View asset docs"

My point was that the schema uses externalDocsUrl for "Absolute URL to externally-hosted documentation". Our UI doesn't have to exactly match the wording of the schema, but by omitting "external" from the button text, it isn't as straight forward that a value set in externalDocsUrl shows up in "View library docs", but we can update our schema documentation to help inform maintainers of where externalDocsUrl shows up in the interface.