Introduction
DX Onboarding relies on pull request data and start dates. This article will take you through the steps to ensure your account is ready to go!
Step 1: Configure webhook
DX uses pull request merge rates to measure ramp-up time. To get this data, DX listens for webhooks. To configure your webhook, go to the in-app onboarding setup page and follow the step-by-step instructions on the page.
Step 2: Configure survey sender
To get qualitative onboarding insights, DX messages developers with a short survey. For higher engagement, you'll customize who this message comes from and what the prompt says. To configure the sender, go to the in-app onboarding setup page.
Step 3: Set start dates and usernames
Populate required user properties to make sure your developers have start dates and usernames (GitHub or GitLab) set. DX needs this data to associate pull requests to the right person and calculate tenure correctly.
⚠️ If you're using the manual profile editor, make sure to incorporate it into your engineering IT onboarding checklist as soon as possible in order to not miss any onboarding insights.
Step 4: Data backfill
DX will backfill ramp-up time metrics so that you can see historical data. Before running the backfill, you may see inaccurate time-to-Nth PR metrics.
To grant the necessary access to DX, follow the instructions for GitHub or the instructions for GitLab, depending on which source control provider you use.
Step 5: Omit engineers (optional)
After getting historical ramp-up time metrics you may find that there are engineers you want to exclude from your data, so that the results aren't skewed. For example, you might decide to exclude SREs who aren't expected to contribute heavily via pull requests. You can omit engineers by individual or by custom attribute (e.g. role) from your onboarding settings page.
FAQs
Why aren't I seeing any users in onboarding?
Users appear in onboarding when they have a start date and at least one associated pull request. If users aren't showing, they are missing a start date or haven’t had any pull requests matched with their username.
Who receives the onboarding survey?
A user will be invited to participate in the onboarding survey if:
They have a start date set.
Their tenure, based on the start date, is between 85 and 120 days.
They've recently merged a pull request.
They haven’t been prompted by DX to take the onboarding survey before.
What if my ramp-up time metrics seem inaccurate?
Ramp-up time metrics can be inaccurate if historical data has not been backfilled yet. Please contact your DX Account Representative to run or re-run a backfill.
Can I set up onboarding without granting API access for a data backfill?
If granting DX temporary API access for the data backfill isn’t feasible, there are two options available:
Skip the data backfill and track ramp-up time metrics going forward.
Manually pull the necessary data and provide DX with a CSV.
Tell your DX Account Representative which option you'd like to proceed with.