Skip to content

Commit 0d0b72f

Browse files
committed
cleanup setup guide and add callouts
1 parent f5799c5 commit 0d0b72f

File tree

1 file changed

+15
-3
lines changed
  • src/connections/auto-instrumentation

1 file changed

+15
-3
lines changed

src/connections/auto-instrumentation/setup.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,15 @@ title: Auto-Instrumentation Setup
33
hidden: true
44
---
55

6+
This guide outlines the steps required to set up the Signals SDK in your applications using Swift or Kotlin.
67

7-
<!--- something about the SDK -->
8+
You'll learn how to add Auto-Instrumentation sources, integrate dependencies, and ensure that your setup captures and processes data as intended.
9+
10+
> info "Auto-Instrumentation Pilot"
11+
> Auto-Instrumentation is currently in pilot and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment doesn't recommend Auto-Instrumentation for use in a production environment, as Segment is actively iterating on and improving the user experience.
12+
13+
> success "Enable Auto-Instrumentation in your workspace"
14+
> To enable Auto-Instrumentation in your Segment worksapce, reach out to your dedicated account manager.
815
916
## Step 1: Add a source and get its write key
1017

@@ -105,7 +112,6 @@ Follow these steps to integrate the Signals SDK into your Kotlin application:
105112

106113
4. Build and run your app.
107114

108-
109115
## Step 3: Verify and deploy events
110116

111117
Next, you'll need to verify signal emission and create rules to convert those signals into events:
@@ -123,4 +129,10 @@ Segment displays `Rule updated successfully` to verify that it saved your rule.
123129
124130
## Step 4: Redeploy your application
125131
126-
After you've finiseh
132+
After you've finished deploying your new rule(s), redeploy your application.
133+
134+
Redeployment ensures that the new rules are active and that your application can generate events from signals.
135+
136+
## Next steps
137+
138+
This guide walked you through initial Signals SDK/Auto-Instrumentation setup. Next, read the [Auto-Instrumentation Signals Implementation Guide](/docs/connections/auto-instrumentation/configuration/), which dives deeper into Signals and offers examples rules.

0 commit comments

Comments
 (0)