Getting Started

Onboarding checklist

The 4-step activation checklist that guides new users through connecting tools, creating a team, and inviting teammates.

After you complete the setup wizard, Koalr displays a persistent onboarding checklist card on your dashboard. The checklist tracks four activation steps and disappears once all steps are complete or you dismiss it.

The card header reads "Getting Started" and shows a progress bar with the count of completed steps (for example, "2 of 4 complete").

The four steps

StepLabelWhere it linksWhat it does
1Connect GitHub/integrations/github/connectOpens the GitHub OAuth flow to connect your source control
2Create your first team/teams/newCreates a team and maps GitHub contributors to it
3Connect Jira or Linear/integrationsOpens the integrations page to connect your issue tracker
4Invite a teammate/settings/membersOpens the members page where you can send email invitations

Each step shows a circle icon when incomplete and a green checkmark when done. Completed steps have their label struck through.

Step 1: Connect GitHub

If you already connected GitHub during the setup wizard, this step is automatically marked complete. Otherwise, click the step to open the GitHub connection page and complete the OAuth authorization.

Once GitHub is connected, Koalr begins syncing pull requests, deployments, and CODEOWNERS files. See Connect your first integration for full details on what gets synced.

Step 2: Create your first team

Click the step to go to /teams/new. Enter a team name, select repositories to associate with the team, and optionally add team members.

Teams are the primary grouping in Koalr. DORA metrics, deploy risk scores, and flow metrics are all scoped to teams. See Team setup for a detailed walkthrough.

Step 3: Connect Jira or Linear

Click the step to open the Integrations page. Connect either Jira or Linear (or both) to enable issue cycle time tracking, sprint velocity, and lead time phase breakdowns.

This step is marked complete when at least one issue tracker integration has an active connection. See Jira integration or Linear integration for provider-specific setup instructions.

Step 4: Invite a teammate

Click the step to open Settings > Members. Enter a colleague's email address and click the invite button. The invited user receives an email with a link to join your Koalr organization.

This step is marked complete when at least one invitation has been sent.

Completion

When all four steps are done, the checklist header changes to "You're all set!" with the message: "All onboarding steps complete. You can dismiss this card."

Dismissing the checklist

Click the X button in the top-right corner of the checklist card to dismiss it at any time, even if steps are incomplete. The checklist will not reappear after dismissal.

If you dismissed the checklist before completing all steps, you can still perform any remaining actions manually through the sidebar navigation.

What's next

Onboarding checklist | Koalr Docs