newrelic / developer-website

Source code for the New Relic Developer Site.
https://developer.newrelic.com
Apache License 2.0
40 stars 114 forks source link

[Public Catalog] Display the Documentation details for packs under the "Data source" tab #1516

Closed rudouglas closed 3 years ago

rudouglas commented 3 years ago

Description

Once the Data source tab is added to a pack as part of #1511 , if any new documentation info is available populate that data in the tab. This data should come from the config.yml e.g.:

documentation:
  - name: AWS RDS installation docs
    description: This is the description
    url: https://docs.newrelic.com/docs/integrations/amazon-integrations/aws-integrations-list/aws-rds-monitoring-integration

This should be a Tile component showing the

In future packs may have multiple references to documentation, so ensure that we account for this when displaying content in the tab.

NOTE: the design image shows this tile under Overview tab, but it should be under Data sources

Screenshot 2021-08-16 at 14 07 20

Acceptance Criteria

aswanson-nr commented 3 years ago

@jpvajda We display a sort of "category" for each component at the bottom of the tile.

Screen Shot 2021-08-23 at 1 31 58 PM

Do we want to add a "documentation" category to it? This is actually a comment for https://github.com/newrelic/newrelic-observability-packs/issues/135

aswanson-nr commented 3 years ago

Blocked on the documentation field getting stitched in

zstix commented 3 years ago

This has been merged into our feature branch. We're still missing some copy at the top of this tab, but we can tackle that when we receive that content (added to the production readiness list).