You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/partners/destinations/index.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,9 @@ After your code is deployed, you'll receive an invitation to join the Segment De
64
64
65
65
### Write documentation
66
66
67
-
Documentation is integral to enabling Segment's users to self-serve and onboard with your integration. Segment's documentation team will work with you during this part of the process to ensure your documentation matches the Segment style and is as instructive as possible. To create your documentation, follow the instructions outlined [in this template](https://github.com/segmentio/segment-docs/blob/develop/templates/partners/destination-new.md){:target="_blank"} if your destination is net new; If your destination is an updated version of a classic destination, follow the instructions outlined [in this template](https://github.com/segmentio/segment-docs/blob/develop/templates/partners/destination-update.md).
67
+
Documentation is integral to enabling Segment's users to self-serve and onboard with your integration. Segment's documentation team will work with you during this part of the process to ensure your documentation matches the Segment style and is as instructive as possible.
68
+
69
+
To create your documentation, follow the instructions outlined [in this template](https://github.com/segmentio/segment-docs/blob/develop/templates/partners/destination-new.md){:target="_blank"} if your destination is net new; If your destination is an updated version of a classic destination, follow the instructions outlined [in this template](https://github.com/segmentio/segment-docs/blob/develop/templates/partners/destination-update.md){:target="_blank"}.
Copy file name to clipboardExpand all lines: src/partners/sources.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,9 @@ Check the Source Debugger to verify that the events arrive and are formatted acc
43
43
44
44
## Write your source's documentation
45
45
46
-
Documentation is integral to enabling Segment's users to self-serve and onboard with your integration. Segment's documentation team will work with you during this part of the process to ensure your documentation matches the Segment style and is as instructive as possible.To create your documentation, follow the instructions outlined [in this template](https://github.com/segmentio/segment-docs/blob/develop/templates/partners/source.md){:target="_blank"}. When submitting your source integration for review, you will need to include a link to the pull request you made to add your documentation.
46
+
Documentation is integral to enabling Segment's users to self-serve and onboard with your integration. Segment's documentation team will work with you during this part of the process to ensure your documentation matches the Segment style and is as instructive as possible.
47
+
48
+
To create your documentation, follow the instructions outlined [in this template](https://github.com/segmentio/segment-docs/blob/develop/templates/partners/source.md){:target="_blank"}. When submitting your source integration for review, you will need to include a link to the pull request you made to add your documentation.
Copy file name to clipboardExpand all lines: templates/partners/destination-new.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,25 +32,25 @@
32
32
33
33
## title: <integration_name> Destination
34
34
35
-
<!--This template is meant for Actions-based destinations that do not have an existing Classic or non-Actions-based version. For Actions Destinations that are a new version of a classic destination, see the doc-template-update.md template.-->
35
+
> (delete after reading) This template is meant for Actions-based destinations that do not have an existing Classic or non-Actions-based version. For Actions Destinations that are a new version of a classic destination, see the doc-template-update.md template.
36
36
37
-
<!--In the section above, edit the `title` field. For example, Slack (Actions) Destination-->
37
+
> (delete after reading) In the section above, edit the `title` field. For example, Slack (Actions) Destination
38
38
39
39
{% include content/plan-grid.md name="actions" %}
40
40
41
-
<!--Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged.-->
41
+
> (delete after reading) Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged.
42
42
43
43
[<integration_name>](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations.
44
44
45
-
<!--Update your company name and support email address.-->
45
+
> (delete after reading) Update your company name and support email address.
46
46
47
47
This destination is maintained by <integration_name>. For any issues with the destination, [contact their Support team](mailto:support@<integration_name>.com).
48
48
49
-
<!--This include describes the requirement of A.js 2.0 or higher for Actions compatibility, and is required if your destination has a web component.-->
49
+
> (delete after reading) This include describes the requirement of A.js 2.0 or higher for Actions compatibility, and is required if your destination has a web component.
50
50
51
51
{% include content/ajs-upgrade.md %}
52
52
53
-
<!--The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination.-->
53
+
> (delete after reading) The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination.
54
54
55
55
## Getting started
56
56
@@ -59,16 +59,16 @@ This destination is maintained by <integration_name>. For any issues with the de
59
59
3. Click **Configure <desintation_name>**.
60
60
4. Select an existing Source to connect to <destination_name> (Actions).
61
61
62
-
<!--The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions.-->
62
+
> (delete after reading) The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions.
63
63
64
64
{% include components/actions-fields.html %}
65
65
66
-
<!--
67
-
Additional Context
68
66
69
-
Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping.
70
-
-->
67
+
> (delete after reading) Additional Context
68
+
>
69
+
> Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping.
70
+
71
71
72
72
---
73
73
74
-
> Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team.
74
+
> (delete after reading) Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team.
Copy file name to clipboardExpand all lines: templates/partners/destination-update.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,30 +32,30 @@
32
32
33
33
## title: <integration_name> Destination
34
34
35
-
<!--This template is meant for Actions-based destinations that represent a new version of an existing, or Classic Segment destination. For new Actions-based destinations, see destination-new-template.md template-->
35
+
> (delete after reading) This template is meant for Actions-based destinations that represent a new version of an existing, or Classic Segment destination. For new Actions-based destinations, see destination-new-template.md template.
36
36
37
-
<!--In the section above, edit the `title` field. For example, Slack (Actions) Destination-->
37
+
> (delete after reading) In the section above, edit the `title` field. For example, Slack (Actions) Destination.
38
38
39
39
{% include content/plan-grid.md name="actions" %}
40
40
41
-
<!--Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged.-->
41
+
> (delete after reading) Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged.
42
42
43
43
[<integration_name>](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations.
44
44
45
-
<!--Update your company name and support email address.-->
45
+
> (delete after reading) Update your company name and support email address.
46
46
47
47
This destination is maintained by <integration_name>. For any issues with the destination, [contact their Support team](mailto:support@<integration_name>.com).
48
48
49
-
<!--In the section below, add your destination name where indicated. If you have a classic version of the destination, ensure that its documentation is linked as well. If you don't have a classic version of the destination, remove the second and third sentences.-->
49
+
> (delete after reading) In the section below, add your destination name where indicated. If you have a classic version of the destination, ensure that its documentation is linked as well. If you don't have a classic version of the destination, remove the second and third sentences.
50
50
51
51
> success ""
52
52
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) <destination_name> Segment destination. There's also a page about the [non-Actions <destination_name> destination](/docs/connections/destinations/catalog/<destination_name>/). Both of these destinations receives data from Segment.
53
53
54
-
<!--This include describes the requirement of A.js 2.0 or higher for Actions compatibility, and is required if your destination has a web component.-->
54
+
> (delete after reading) This include describes the requirement of A.js 2.0 or higher for Actions compatibility, and is required if your destination has a web component.
55
55
56
56
{% include content/ajs-upgrade.md %}
57
57
58
-
<!--In the section below, explain the value of this actions-based destination over the classic version, if applicable. If you don't have a classic version of the destination, remove this section.-->
58
+
> (delete after reading) In the section below, explain the value of this actions-based destination over the classic version, if applicable. If you don't have a classic version of the destination, remove this section.
59
59
60
60
## Benefits of <destination_name> (Actions) vs <destination_name> Classic
61
61
@@ -64,7 +64,7 @@ This destination is maintained by <integration_name>. For any issues with the de
64
64
-**Main point 1**. One or two sentences that back up the main point.
65
65
-**Main point 2**. One or two sentences that back up the main point.
66
66
67
-
<!--The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination.-->
67
+
> (delete after reading) The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination.
68
68
69
69
## Getting started
70
70
@@ -73,21 +73,21 @@ This destination is maintained by <integration_name>. For any issues with the de
73
73
3. Click **Configure <desintation_name>**.
74
74
4. Select an existing Source to connect to <destination_name> (Actions).
75
75
76
-
<!--The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions.-->
76
+
> (delete after reading) The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions.
77
77
78
78
{% include components/actions-fields.html %}
79
79
80
-
<!--
81
-
Additional Context
82
-
Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping.
83
-
-->
84
80
85
-
<!-- If applicable, add information regarding the migration from a classic destination to an Actions-based version below -->
81
+
> (delete after reading) Additional Context
82
+
>
83
+
> Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping.
84
+
85
+
86
86
87
87
## Migration from the classic <destination_name> destination
88
88
89
-
<!-- Include any pertinent information here. -->
89
+
> (delete after reading) If applicable, add information regarding the migration from a classic destination to an Actions-based version below.
90
90
91
91
---
92
92
93
-
> Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team.
93
+
> (delete after reading) Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team.
Copy file name to clipboardExpand all lines: templates/partners/source.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,23 +32,23 @@
32
32
33
33
## title: <integration_name> Source
34
34
35
-
<!--Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged.-->
35
+
> (delete after reading) Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged.
36
36
37
37
[<integration_name>](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations.
38
38
39
39
This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations.
40
40
41
-
<!--Update your company name and support email address.-->
41
+
> (delete after reading) Update your company name and support email address.
42
42
43
43
This source is maintained by <integration_name>. For any issues with the source, [contact their Support team](mailto:support@<integration_name>.com).
44
44
45
-
<!--Update your company name (x2) and support email address.-->
45
+
> (delete after reading) Update your company name (x2) and support email address.
46
46
47
47
_**NOTE:** The <integration_name> Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on <Month_Name DD, YYYY>. If you are interested in joining their beta program or have any feedback to help improve the <integration_name> Source and its documentation, [let their team know](mailto:support@<integration_name>.com)!_
48
48
49
49
## Getting Started
50
50
51
-
<!--Include clear, succinct steps including hyperlinks to where customers can locate the place in your app to enter their Segment writekey.-->
51
+
> (delete after reading) Include clear, succinct steps including hyperlinks to where customers can locate the place in your app to enter their Segment writekey.
52
52
53
53
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
54
54
2. Search for "<integration_name>" in the Sources Catalog, select <integration_name>, and click **Add Source**.
@@ -61,15 +61,15 @@ _**NOTE:** The <integration_name> Source is currently in beta, which means that
61
61
62
62
## Stream
63
63
64
-
<!--Clarify the type of Segment events your integration will send-->
64
+
> (delete after reading) Clarify the type of Segment events your integration will send.
65
65
66
66
<integration_name> uses our stream Source component to send Segment event data. It uses a server-side (select from `track`, `identify`, `page`, `group`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
67
67
68
-
<!--Clarify how your integration includes user identifiers in your event payloads, the example below is from Klaviyo-->
68
+
> (delete after reading) Clarify how your integration includes user identifiers in your event payloads, the example below is from Klaviyo:
69
69
70
70
The default behavior is for Klaviyo to pass the userId associated with the email recipient as the userId. There are cases in which Klaviyo does not have an associated userId, in which case the email address will be passed in as the anonymousId.
71
71
72
-
<!--For each of the below sections, populate the event and properties that a customer would expect to receive in their downstream tools from your Event Source.-->
72
+
> (delete after reading) For each of the below sections, populate the event and properties that a customer would expect to receive in their downstream tools from your Event Source.
0 commit comments