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!

[Erik Budtke · Accepted solution]

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!