Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

External component description content

Keith Furnell
Contributor
March 16, 2025

The "Description" field of the Overview page provides both a plain-text field and (since this recent change) a fuller rich-text "More details" field (which are kind of analogous to the "summary" and "description" fields respectively of OpenAPI).

Often the descriptive content that might be used to populated these fields will already exist elsewhere. Is there any intention for the Overview page to eventually allow displayed content to be sourced from:

  • wiki files (i.e. README.md) committed to the linked repository
  • a Confluence excerpt macro
  • a "starred" link from the Documentation page

Any of these would seem preferable to duplicating such content in a Compass-specific place.

0 answers

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events