Centralize developer documentation

The developer documentation feature helps development teams centralize and link their critical documentation to Compass components. This allows developers to quickly find relevant and accurate documentation for the services, applications, and other component types they manage through their catalog.

Once a document has been added to a component, you can sort documents by category, who added the document, and the date they added it.

In Compass, documentation falls into four distinct categories:

• Discover: Specifications, key concepts, and core features that can help your team understand a component.

• Contributor: Standards, guides, and diagrams that help your teammates contribute to and integrate with a component.

• Maintainer: Runbooks and dashboards to help your team maintain a component.

• Other: All other documentation related to a component.

Add documentation to a component

In Compass, if you have a link to your documentation, you can add it to a component.

1. From the component sidebar, select Documentation.

2. Select Add documentation.

3. Add details to your documentation, including a category and a URL, starting with either https:// or http://.

4. [追加] を選択します。

Edit or remove documentation

You can also edit or remove documentation that has been added to a component.

1. From the component sidebar, select Documentation.

2. [その他のアクション] アイコン () を選択します。

3. 編集を選択します。

4. Once you’ve updated the document’s details, select Save.

To remove a document:

1. [その他のアクション] アイコン () を選択します。

2. Select Remove.