Getting Started with Swarmia

It's easy to get started. Connect your tools, get onboarded, and get to know the product with our quick start guide.

Connecting Swarmia for the first time?
👉 Start here

Quick start based on your role:

🧑🏻‍🚀 Team lead
👩‍💻 Engineer


Swarmia Champion

  1. Connect Github & Enable Repositories

    1. To install the app, make sure you have the necessary admin permissions on GitHub and find Swarmia in the GitHub Marketplace. Click Install, review the necessary authorizations and click Install &Authorize. You will then be taken to the onboarding wizard. Give a name for your organization and click Next.
  2. Connect your Issue Tracker (Optional)
    1. Connecting Jira

      Follow these step-by-step instructions to connect Swarmia to Jira Cloud and set up the integration.

      Teams can configure which issues they own, but the issue type and workflow mappings apply to the whole organization. Follow the step-by-step instructions in this article to map the Jira issues and workflow.

      If you're using Jira Server or Jira Data Center, the process requires a bit more steps. Please refer to these instructions for getting started.

    2. Connecting Linear
      If you're using Linear as your issue tracker, follow these instructions to set up the integration.
      You'll also find instruction on how to assign the work in Linear teams to team on Swarmia. 
  3. If using Jira, configure organization settings as shown in this video.
  4. Connect you Slack workspace
    1. In the onboarding wizard, or in Slack settings in Swarmia, click Integrate Slack. Sign in to your Slack workspace, review the permissions, and click allow. 
  5. Review & Merge Active Contributors
    1. To ensure data quality, the contributors list in your organization shouldn't include duplicate identities. You can leverage this video to see how this is done in the Contributor Settings page in Swarmia. 
  6. Configure Investment Categories 
    1. Follow these instructions to set up Investment Categories for your organization. Once these have been defined, be sure to share the criteria with your team so they know how to properly map their work to these categories. 
  7. Auto-Exclude Rules for PRs if organizationally relevant
    1. See how to set this up for your organization in this video.
  8. Set up DORA metrics
    1. We support all four DORA metrics in Swarmia and are able to do so by connecting to your organization's deployment data through an API. 
      Reach out to your CSM for the API Token for your organization and follow the instructions in these two articles: 
      1) Sending Deployments via API to measure Change Failure Rate and Mean Time To Recovery 2) Change Failure Insights
  9. Onboard your organization! 
    1. At Swarmia, provide value to all levels of your organization and offer 1:1 onboarding support to all levels as well. Contact your CSM to determine the best way to rollout Swarmia to the rest of your organization. 
      You can also invite new team members from your organization to join Swarmia by sharing the Invite Link found on the Swarmia Home Page.  

Team Lead

  1. Create your Team
    1. We leverage your contributors and teams from GitHub that allow us to make Team Creation and Management super easy for you! Watch this short video on how to create your team.
  2. Enable Slack Daily Digests
    1. Daily Digests are a customer favorite feature and provide timely updates to your team. You can enable these for your team by connecting to a public or private slack channel. This short video explains how to get this set up. 
  3. Confirm Personal Settings 
    1. Now that you have your team created, you'll want to go into your Personal Settings and update your Primary Team. We use this field to default the views in Swarmia to the team you selected.
      You also would have seen in the video shared above about Slack that we provide Personal Slack notifications as well. Don't forget to update your preferences for these notifications in your Personal Settings.  
  4. Map Issue Tracker to your Swarmia Team
    1. Jira Users - Watch this short tutorial on how to map your Jira Issues to your Swarmia Team.
    2. Linear Users - Watch this short tutorial on how to map your Linear Team to your Swarmia Team.
  5. Auto-Exclude Rules for PRs if team specific
    1. If your team would like to set up a rule to auto-exclude Pull Requests from your data that is specific to your team, watch this short video on how to set this up. 
  6. Watch Product Tour Video
    1. New to Swarmia? Check out this awesome Product Tour that will give you a high-level view of how to use the tool as well as some key features. If you have additional questions, don't hesitate to reach out to your CSM!
  7. Check Out these Help Center Articles
    1. Retrospective Guide
    2. Reducing Pull Request Cycle Time
    3. Analyze team focus and time allocation with the Investment Distribution view
    4. About Working Agreements 

Engineer

  1. Create your Swarmia Account
    1. Create your Swarmia Account by leveraging your GitHub SSO and following the steps provided by the onboarding wizard. (You'll need a link to your organization's instance to get started. Ask your Team Lead or Manager to provide one to you)
  2. Choose Primary Team
    1. In the onboarding wizard, or in Personal Settings in Swarmia, you can choose your Primary Team. We use this field to default the views in Swarmia to the team you selected.
  3. Enable Personal Slack Notifications
    1. In the onboarding wizard, or in Personal Notification Settings in Swarmia, you can choose to enable your Personal Slack Notifications and configure them based on your needs. 
  4. Watch Product Tour Video
    1. New to Swarmia? Check out this awesome Product Tour that will give you a high-level view of how to use the tool as well as some key features. If you have additional questions, don't hesitate to reach out to your CSM!
  5. Check out these Help Center Articles
    1. Analyzing the activity patterns on Work Log
    2. Analyzing Pull Request batch size
    3. Diagnosing low Pull Request Throughput
    4. About Working Agreements