Skip to main content
Atlassian Logo
  • Apps
  • Documentation
  • Resources
  • Contact us
  • Sign in
  • Sign in
Compass
Compass Cloud

Documentation

  • Set up Compass
    • Getting started with Compass
      • What is Compass?
      • Set up your Compass site
      • Learn how Compass works
      • Understand user roles in Compass
    • Build your software catalog
      • What are components?
      • Search the component catalog
      • Create, view, update, and archive components
      • Assign a component owner
      • Add component details
      • What are templates?
      • Create a template
      • Use a template
    • Import components into your catalog
      • Import components from Bitbucket Cloud
      • Import components from GitHub
      • Import components from GitLab
      • Import components from Jira Service Management
      • Import components from New Relic
      • Import components from repositories linked to Jira
    • Use Compass with other Atlassian products
      • Link Jira issues to components
      • Sync components with Jira Service Management
      • Add Jira issues to Compass scorecards
      • Integrate Compass with Bitbucket Cloud
      • Integrate Compass with Opsgenie
      • Integrate Compass with Statuspage
    • Use Compass with other applications
      • Integrate Compass with CircleCI
      • Integrate Compass with GitHub
      • Integrate Compass with GitLab
      • Integrate Compass with PagerDuty
      • Integrate Compass with Sentry
      • Integrate Compass with Slack
      • Integrate Compass with Snyk
  • Import data from other tools
    • Populate component events
      • Configure incoming webhooks
      • Create and use incoming webhooks
      • Delete incoming webhooks
    • Populate component metrics
      • What are component metrics?
      • Create component metrics
      • Connect, view, and disconnect component metrics
      • Get metrics from integrated tools
      • What are derived metrics?
      • Available predefined metrics
  • Maintain components your team owns
    • Manage components and dependencies
      • Maintain components
      • Manage your component catalog
      • Manage component types
      • Announce component changes
      • Add component dependencies
      • Set component tiers
      • Centralize developer documentation
      • Manage API specifications
      • Manage package dependencies
  • Manage and administer Compass
    • Administer Compass for your company
      • Change product plan
      • Manage users and their product access
      • Manage custom fields
      • View Compass audit logs in Atlassian Administration
      • Enable pending components
    • Understand user roles and permission policies
      • How do Compass permissions work?
      • Select a permission policy
  • Set standards for component health
    • Understand how scorecards work
      • What are scorecards?
    • Create and manage scorecards
      • Create, publish, and delete scorecards
      • Understand methods for applying scorecards
      • Apply or remove scorecards
    • Create and manage scorecard criteria
      • Use custom fields with scorecards
      • Use metrics with scorecards
    • Track component health with scorecards
      • Understand component health
      • View and update a component's score
      • Monitor your team’s component health via Slack
  • Build teams and operational practices
    • Create and manage teams
      • Create or find teams
      • Monitor your team dashboard
      • What is the developer experience dashboard?
    • Set up your team's operations
      • Set up team operations
      • Add contact methods
      • Manage user roles
      • Integrate an operations tool
      • Show on-call information from incident management tools on a component
      • Work with advanced integration settings
    • Manage alerts and on-call schedules
      • How alerts are created
      • Manage alert notifications
      • Create incidents with alerts
      • What is the heartbeats feature?
      • How on-call schedules work
      • Manage an escalation policy
      • Override an on-call schedule
      • View reports of operations
  1. Atlassian Support
  2. Compass
  3. Resources
  4. Set up Compass

Getting started with Compass

  • What is Compass?

    Learn the basics of Compass, your developer platform for managing your software catalog and improving developer experience.

  • Set up your Compass site

    Get up and running with a new Compass site, or add Compass to one of your existing Atlassian sites.

  • Learn how Compass works

    Understand how Compass basics like components, teams, and scorecards help you track the things your engineering teams build.

  • Understand user roles in Compass

    Read about user roles and feature access in Compass.

Was this helpful?

Still need help?

The Atlassian Community is here for you.
Ask the Community
  • Explore more
  • What is Compass?
  • Set up your Compass site
  • Learn how Compass works
  • Understand user roles in Compass
  • Set up Compass
  • Getting started with Compass

  • Build your software catalog
  • Import components into your catalog
  • Use Compass with other Atlassian products
  • Use Compass with other applications
CommunityQuestions, discussions, and articles
Atlassian Logo
  • Accessibility
  • Notice at Collection
  • Privacy Policy
  • Terms of Use
  • Security
  • 2025 Atlassian