nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

DOCUMENT links aren't updating from compass.yml

David Zwarg

Hello,

We are onboarding some new development teams to Compass, and observed the following behavior:

New components that are using config-as-code (updating the contents of compass.yml) cannot get Documentation links to appear.

According to Add component details, "Documentation" is a valid link type. When viewing a manually-edited component, the snippets include:

links:
  - name: Design System Portal
    type: DOCUMENT
    url: 'https://my.design.system'

However, Structure and contents of a compass.yml file does NOT list "DOCUMENT" as a valid link type, and when a compass.yml file contains these links, they are ignored.

Please advise on how our teams can document their components using config-as-code in the method supported by the Compass product.

Thank you!

Accepted answers

Erik Budtke

Hey @David Zwarg !

Apologies for the confusion about what's currently supported, I'll make sure to update our documentation to be accurate in both places. Thanks for the report!

In terms of what is accurate, right now we do not support documents through config as code unfortunately. The 'document' link type was deprecated when we promoted those links into a standalone feature (like what you see when you click 'Documentation' in the left hand nav of a given component).

We have it as an item on our backlog to address this shortcoming, so I'll make sure to add this post to that ticket to help get it prioritized sooner. For now, your teams will have to manually add their documents either via the UI or through our GraphQL API.

Hope this answers your question!

All comments

Erik Budtke

Hey @David Zwarg !

Apologies for the confusion about what's currently supported, I'll make sure to update our documentation to be accurate in both places. Thanks for the report!

Hope this answers your question!

DarrenDooley

Hey @Erik Budtke! Does your team have a progress update on the backlog item you mentioned? Hoping to add documentation via config-as-code.

Keith Furnell

This answer looks to have been accepted on the basis that the documentation will be updated to reflect this fairly glaring shortcoming, however:

Add component details still lists "Documentation" as a valid link type, implying that it, like all other link types, is supported by config-as-code
Structure and contents of a compass.yml file does not

Moreover generated compass.yml content still includes all manually added links with "type: DOCUMENT" (though without their Category). This leads to the strong impression that documents are supported, as you would hope, though in reality it seems that any changes/additions to these types of link in compass.yml are ignored.

Is there any movement on the backlog item to address this?

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

documentation

yaml

compass

config