Skip to main content

Turn on Compass

Compass gives each component a score, based on rules such as "has an owner" or "has documentation". You turn it on once, in the administration.

Before you start​

You need to be an administrator. Compass needs no connection for its first rules: they read the catalog.

🔌 Turn on the plugin​

  1. In the left sidebar, at the bottom, click Administration.

  2. In the Administration menu, under PLATFORM, click Plugins.

  3. On the Compass card, click the switch at the top right of the card. It turns on at once.

A new entry, Compass, appears in the Administration menu, under INTELLIGENCE. Click it: the Compasses tab already holds one compass, Catalog essentials, with six rules about what every component should say about itself (an owner, a description, a lifecycle, a system, documentation, a link to its repository).

Each component now has a Compass tab, and a Compass Statistics card on its Overview.

✅ That's it!

Next: See the score of a component.