Skip to content

Commit 88a44ec

Browse files
authored
Merge pull request #411 from segmentio/repo-sync
repo sync
2 parents 0a5aa70 + b04e709 commit 88a44ec

File tree

10 files changed

+94
-80
lines changed

10 files changed

+94
-80
lines changed

.github/Vocab/Docs/accept.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
(?:C|c)annonical
22
(?:C|c)onfig
3+
(?:C|c)rypto
34
(?:D|d)eduplicate
45
(?:D|d)eduplication
56
(?:G|g)tag
67
(?:K|k)laviyo
8+
(?:L|l)odash
79
(?:L|l)ookback
810
(?:P|p)ageviews?\b
911
(?:P|p)endo
@@ -19,6 +21,7 @@ allowlist
1921
Amberflo
2022
Appboy
2123
Appsflyer
24+
async
2225
Blitzllama
2326
blocklist
2427
boolean
@@ -39,6 +42,7 @@ Friendbuy
3942
ga
4043
gmail
4144
Gradle
45+
Heatmapping
4246
href
4347
html
4448
http
@@ -83,6 +87,7 @@ utm
8387
Vero
8488
Vidora
8589
viewability
90+
waitlist
8691
WebKit
8792
Wootric
8893
Zendesk
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<div class="premonition info"><div class="fa fa-info-circle"></div><div class="content"><p class="header">Developer Center no longer accepts new components.</p><p markdown=1>Segment is redeveloping the Developer Center and will launch a new version when complete. To stay up to date, add your contact information [here](https://airtable.com/shrT3b4C7agUEBKVS){:target="_blank"}.</p></div></div>

src/connections/destinations/catalog/google-analytics/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ If you send a [`screen`](/docs/connections/spec/screen) call using a server libr
6060

6161
### Virtual Pageviews
6262

63-
Virtual pageviews are when you send a pageview to Google Universal Analytics when the page URL didn't actually change, for example when a full-screen modal dialog appears. You can do this with Segment by making a [Page call](/docs/connections/spec/page/) with optional properties, like in the following example.
63+
Virtual pageviews are when you send a pageview to Google Universal Analytics when the page URL didn't actually change, for example when a full-screen modal dialog appears. You can do this with Segment by making a [Page call](/docs/connections/spec/page/) with optional properties, like in the following example. Include both the category and name, in addition to the properties.
6464

6565
```javascript
66-
analytics.page({
66+
analytics.page('Form', 'Signup Modal', {
6767
title: 'Signup Modal',
6868
url: 'https://segment.com/#signup',
6969
path: '/#signup',

src/partners/index.md

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
title: Developer Center Overview
33
---
44

5-
> note ""
6-
> **NOTE:** Developer Center is currently in _Developer Preview_. If you are interested in joining the Developer Preview, request access [here](https://segment.com/partners/developer-center/). The use is governed by [(1) Segment First Access](https://segment.com/legal/first-access-beta-preview/) and Beta Terms and Conditions and [(2) Segment Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/). By starting or continuing this process, you also agree to the [Segment Platform Partners Agreement](https://segment.com/legal/partnersagreement/).
5+
{% include content/dev-center-note.md %}
76

87

98
## Building on Segment
@@ -14,15 +13,15 @@ Below is a sample screenshot of a customer's Segment dashboard, showing all thei
1413

1514
![](images/overview.png)
1615

17-
Segment's core feature is our Connections Catalog:
16+
Segment's core feature is the Connections Catalog:
1817

1918
![](images/catalog.gif)
2019

2120
Customers discover your Sources and Destinations using the Connections Catalog and can enable them from there.
2221

2322
The development process is simple:
2423

25-
1. Understand Segment's [Conceptual Model](/docs/partners/conceptual-model) and [Spec](https://segment.com/docs/connections/spec).
24+
1. Understand Segment's [Conceptual Model](/docs/partners/conceptual-model) and [Spec](/docs/connections/spec).
2625
2. Follow Segment's security guidance.
2726
3. Request [access to the Segment Developer Center](https://segment.com/partners/developer-center/).
2827
4. Create an App.
@@ -37,7 +36,7 @@ It's important to understand Segment's [Conceptual Model](/docs/partners/concept
3736

3837
### 2. Follow Segment's security guidance
3938

40-
Security is a priority for us at Segment for both our customers and our partners. Before you start building on the Developer Center, please review our [Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/) and ensure you're following the below guidance:
39+
Security for both customers and partners is a priority at Segment. Before you start building on the Developer Center, review the [Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/) and ensure you're following the below guidance:
4140

4241
- Follow a secure software-development lifecycle, which enables you to create code that is safe for Segment customers and their end users, and that enables you to maintain and raise the security of that code over time
4342
- If you or your code comes into contact with Segment customer- or end-user data for any reason, protect it with commercially reasonable methods throughout its data lifecycle, including creation, handling, transporting, storing and destruction.
@@ -48,14 +47,12 @@ Security is a priority for us at Segment for both our customers and our partners
4847

4948
During _Developer Preview_, you will need to [request access to Developer Center](https://segment.com/partners/developer-center/). A Segment account is required for this step.
5049

51-
We receive a large volume of requests so we encourage you to include a valid company website and email address, answer all questions with details about integration's use case as well as highlighting specific customer requests to expedite the approval process.
50+
Segment receives a large volume of requests so please include a valid company website and email address, answer all questions with details about integration's use case as well as highlighting specific customer requests to expedite the approval process.
5251

5352
### 4. Create your App
5453

55-
Once approved, you can create your first [App](/docs/partners/conceptual-model/#apps). This represents a tile in the [Segment catalog](https://segment.com/catalog/) irrespective of which [Component](/docs/partners/conceptual-model/#components) type you choose to build so it should reflect your tool's name (eg. Zendesk Chat, Zendesk Sell).
54+
Once approved, you can create your first [App](/docs/partners/conceptual-model/#apps). This represents a tile in the [Segment catalog](https://segment.com/catalog/) irrespective of which [Component](/docs/partners/conceptual-model/#components) type you choose to build so it should reflect your tool's name (for example, Zendesk Chat, Zendesk Sell).
5655

57-
> info ""
58-
> The Developer Center currently only supports new Partner integrations (ie. Currently does not exist on the [Segment catalog](https://segment.com/catalog/)) in _Developer Preview_. If you're an existing Partner looking to build a new Component or make changes to your existing integration, fill in [your details here](https://airtable.com/shrSweuRx5jspwsw7) and we'll contact you once this is made available!
5956

6057
### 5. Build & Test
6158

@@ -65,16 +62,14 @@ Now you can start building! Depending on your use case you can build a:
6562
- [Plugin](/docs/partners/plugins)
6663
- [Stream](/docs/partners/streams)
6764

68-
> info ""
69-
> The Developer Center currently only supports the [Subscription](/docs/partners/subscriptions) component in _Developer Preview_. If you're looking to build a [Web Plugin](https://airtable.com/shrT3b4C7agUEBKVS) or [Stream](https://airtable.com/shrj3BkHMhdeaPYWt) fill out the respective form and we'll contact you once this is made available!
7065

71-
No matter which Component you decide to build, make it aligns with the [Segment Spec](https://segment.com/docs/connections/spec). This is a critical component in preserving logical continuity between disparate writers and readers of data. If you encourage customers to break the spec, you are breaking the promise of Segment, and is grounds for removal from the catalog.
66+
No matter which Component you decide to build, make it aligns with the [Segment Spec](/docs/connections/spec). This is a critical component in preserving logical continuity between disparate writers and readers of data. If you encourage customers to break the spec, you are breaking the promise of Segment, and is grounds for removal from the catalog.
7267

73-
It's important that we provide a great experience for our mutual customers so we ask that you also conduct thorough testing of your integration using the tooling provided to you through the Developer Center. We also encourage you to use your Segment sandbox in the shoes of a user to polish the experience of implementing and using your integration.
68+
To provide a positive experience for mutual customers, it's important to test integrations with the tooling provided by the Developer Center. You can also use your Segment sandbox to polish the experience your end users will see.
7469

7570
### 6. Document
7671

77-
Finally, make sure you prepare documentation and relevant marketing material for easy discovery and reference. We ask that you provide the following documentation about your integration by making a copy of the below templates:
72+
Finally, make sure you prepare documentation and relevant marketing material for easy discovery and reference. Provide the following documentation about your integration by making a copy of the below templates:
7873

7974
1. Documentation [hosted by Segment](https://segment.com/docs/) for [Subscription / Plugin](https://hackmd.io/t7amLXluS7-39rg7ARZgSA) or [Stream](https://hackmd.io/TV8cZR6tRnKwGtkvSexeag)
8075
2. Documentation for [the Segment catalog](https://segment.com/catalog/) using [this template](https://docs.google.com/document/d/1kKvqYtZeDPnBjvCrtQSuO3BBH70b_CLO13hYrYIOOtA/edit))
@@ -84,9 +79,9 @@ Finally, make sure you prepare documentation and relevant marketing material for
8479

8580
### 7. Submission
8681

87-
You can submit your Component in the Developer Center for review. We strive to respond to your submission within 2 business days to kickstart the review process.
82+
You can submit your Component in the Developer Center for review. Segment aims to respond to your submission within two business days to kickstart the review process.
8883

89-
Our team will test your integration and review your documentation and marketing material. In order to keep this review feedback loop short, make sure that your integration:
84+
Segment tests your integration and reviews your documentation and marketing material. To keep this review feedback loop short, make sure that your integration:
9085

9186
- Adheres to the [Segment Spec](/docs/connections/spec/)
9287
- Adheres to your published documentation
@@ -99,33 +94,32 @@ See the [Public Beta Checklist](/docs/partners/checklist) for a detailed checkli
9994

10095
In a nutshell you need:
10196

102-
1. A working integration tested end-to-end. We encourage you to follow your own documentation and run through the experience as one of our mutual customers.
97+
1. A working integration tested end-to-end. Follow your own documentation and run through the experience as a mutual customer.
10398

10499
2. Complete the fields under the _App Info_ tab with your App including both _Basic Info_ and _Launch Info_. This includes:
105100

106-
- **Segment Documentation:** Using these templates ([subscription](https://hackmd.io/t7amLXluS7-39rg7ARZgSA?both=)/[stream](https://hackmd.io/TV8cZR6tRnKwGtkvSexeag), document how our mutual customers can use your integration.
101+
- **Segment Documentation:** Using these templates ([subscription](https://hackmd.io/t7amLXluS7-39rg7ARZgSA?both=)/[stream](https://hackmd.io/TV8cZR6tRnKwGtkvSexeag), document how mutual customers can use your integration.
107102
- **Your Documentation:** Similar to the above but hosted on your own website.
108-
- **Catalog Details:** Details for our [catalog](https://segment.com/catalog) material including screenshots by making a copy of [this template](https://docs.google.com/document/d/1kKvqYtZeDPnBjvCrtQSuO3BBH70b_CLO13hYrYIOOtA/copy).
103+
- **Catalog Details:** Details for the [catalog](https://segment.com/catalog) material including screenshots by making a copy of [this template](https://docs.google.com/document/d/1kKvqYtZeDPnBjvCrtQSuO3BBH70b_CLO13hYrYIOOtA/copy).
109104
- **Integrations / Partners Page:** Add your Segment integration to your integrations or partners page.
110105
- **Blog Post:** Publish a launch blog post about your integration, like [this](https://www.kustomer.com/blog/kustomer-segment-integration/). Make sure you share it on Twitter and LinkedIn too! (If you don't have a blog, an email is okay)
111106

112-
Be sure to use our [brand kit](https://brandfolder.com/segment/press-kit) for logos, and our [UTM guide](https://docs.google.com/document/d/1L0MHYdF2SYaMMiodQCYlZELF7pN0TXiZbD22nnlGhEk/copy) any time you link to a Segment page.
107+
Be sure to use Segment's [brand kit](https://brandfolder.com/segment/press-kit) for logos, and Segment's [UTM guide](https://docs.google.com/document/d/1L0MHYdF2SYaMMiodQCYlZELF7pN0TXiZbD22nnlGhEk/copy) any time you link to a Segment page.
113108

114-
You can contact us at [[email protected]](mailto:[email protected]) once you have all these elements ready for review. Once we approve them, your Destination goes live on Catalog in Public Beta 🎉
109+
You can contact Segment Partner Support at [[email protected]](mailto:[email protected]) once you have all these elements ready for review. Once approved, your Destination goes live on the Catalog in Public Beta.
115110

116111
## Post Launch
117112

118113
Congratulations on launching your integration in Public Beta - welcome aboard! Here are the next steps to move out from Public Beta to Public:
119114

120-
1. Implement the [Enable with Segment OAuth](/docs/partners/enable-with-segment) button - this makes it much easier for our mutual customers to get started with your integration!
121-
2. Onboard at least 3 customers to actively use your integration
115+
1. Implement the [Enable with Segment OAuth](/docs/partners/enable-with-segment) button - this makes it much easier for mutual customers to get started with your integration!
116+
2. Onboard at least three customers to actively use your integration
122117

123118
Bonus points if you join the [Segment Select](/docs/partners/#segment-select) Partner Program!
124119

125120
## Segment Select
126121

127-
Our focus when working with partners is to ensure we are always providing an exceptional experience to our joint customers.
128122

129-
From there, you can start taking advantage of our available partner opportunities by [joining the Segment Select Partner Program](https://segment.com/partners/integration/#module-5-benefits).
123+
You can taking advantage of Segment's available partner opportunities by [joining the Segment Select Partner Program](https://segment.com/partners/integration/#module-5-benefits).
130124

131125
By becoming a Segment Select partner, you have access to sales support, technical training, and personalized co-marketing opportunities. [Learn more about the program details here.](https://assets.ctfassets.net/9u2t3ap6pctb/3NPVQDweiX0l8Z2edugwIr/d09ea71f04913f3189514b7d2df57d36/Segment_Select_Partner_Program_One_Pager.pdf)

src/partners/plugins.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,20 @@
22
title: Building a Plugin
33
---
44

5-
> info ""
6-
> The Developer Center currently only supports the [Subscription](/docs/partners/subscriptions) component in _Developer Preview_. Include [your information here](https://airtable.com/shrT3b4C7agUEBKVS) and we'll contact you once _Plugins_ are made available!
5+
{% include content/dev-center-note.md %}
76

8-
SDK Plugins are used to augment traditional Destination and Source components ([Subscriptions](/docs/partners/subscriptions/) and [Streams](/docs/partners/streams/)) by shipping code to the End User's Device. You can use this mechanism to enable customers to dynamically include your libraries or SDKs and to wire up the Segment SDK to invoke them directly when your plugin is enabled. This pattern is most commonly used to build what we call "Device-mode Destinations".
7+
SDK Plugins are used to augment traditional Destination and Source components ([Subscriptions](/docs/partners/subscriptions/) and [Streams](/docs/partners/streams/)) by shipping code to the End User's Device. You can use this mechanism to enable customers to dynamically include your libraries or SDKs and to wire up the Segment SDK to invoke them directly when your plugin is enabled. This pattern is most commonly used to build "Device-mode Destinations".
98

109
Segment's Client SDKs (analytics.js, analytics-ios, and analytics-android) serve as "microcosms" of the Segment Customer Data Infrastructure runtime — they enable the dynamic orchestration of event collection, cleaning and validation, transforming, and delivery to collection endpoints right from inside the SDK.
1110

12-
SDK Plugins are an appropriate component for your App if your source or destination requires client-side side effects, such as collecting ambient data in the client (Heatmapping, Error & Performance Monitoring tools), relying on device-native context such as third party cookies (Advertising pixels), or needs to actively modify the Client UI (e.g. A/B testing, Push Notification, In-App Messaging and LiveChat).
11+
SDK Plugins are an appropriate component for your App if your source or destination requires client-side side effects, such as collecting ambient data in the client (Heatmapping, Error & Performance Monitoring tools), relying on device-native context such as third party cookies (Advertising pixels), or needs to actively modify the Client UI (for example, A/B testing, Push Notification, In-App Messaging and LiveChat).
1312

1413

1514
## Getting Started
1615

17-
Review the steps outlined in the [Developer Center Overview](/docs/partners). This document outlines specific details for Step 4 as it relates to building a plugin.
16+
Review the steps outlined in the [Developer Center Overview](/docs/partners). This document outlines specific details for Step Four as it relates to building a plugin.
1817

19-
1. Understand Segment's [Conceptual Model](/docs/partners/conceptual-model) and [Spec](https://segment.com/docs/connections/spec).
18+
1. Understand Segment's [Conceptual Model](/docs/partners/conceptual-model) and [Spec](/docs/connections/spec).
2019
2. Follow Segment's security guidance.
2120
3. Request [access to the Segment Developer Center](https://segment.com/partners/developer-center/).
2221
4. Create an App.
@@ -36,7 +35,7 @@ Once you've created an App, you're ready to starting building your Plugin. Refer
3635

3736
* [iOS Plugin Docs](https://github.com/segmentio/analytics-ios/wiki/Writing-Integrations)[Mixpanel iOS Plugin Example](https://github.com/segment-integrations/analytics-ios-integration-mixpanel)
3837

39-
As with all partner contributions, only those which follow the Segment [Spec](/docs/connections/spec) will be approved. Once you've finished building your plugin, make sure to reference the above wikis to test your plugin locally. Before reviewing, we'll need to see a full suite of cross-device tests.
38+
As with all partner contributions, only those which follow the Segment [Spec](/docs/connections/spec) will be approved. Once you've finished building your plugin, make sure to reference the above wikis to test your plugin locally. Before reviewing, Segment needs to see a full suite of cross-device tests.
4039

4140
## Next Steps
4241

src/partners/streams.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: Build a Stream
33
---
44

55
> info ""
6-
> The Developer Center currently only supports the [Subscription](/docs/partners/subscriptions) component in _Developer Preview_. Include [your information here](https://airtable.com/shrj3BkHMhdeaPYWt) and Segment will contact you once _Streams_ are made available!
6+
> The Developer Center is currently not accepting new components. Segment is committed to redeveloping the Developer Center and a new version will be launched in the future. Include [your information here](https://airtable.com/shrj3BkHMhdeaPYWt){:target="_blank"} and we'll contact you once _Streams_ are made available!
7+
78

89
Streams enable you to send data to mutual customers from your web services in realtime.
910

0 commit comments

Comments
 (0)