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
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ 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.
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).
Copy file name to clipboardExpand all lines: src/partners/sources.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,6 +41,10 @@ Use the [Source Debugger](/docs/connections/sources/debugger/) to observe inboun
41
41
42
42
Check the Source Debugger to verify that the events arrive and are formatted according to the Segment Spec.
43
43
44
+
## Write your source's documentation
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.
47
+
44
48
## Launch your source
45
49
46
50
When you've verified that your source sends the correct information, submit it for review. The Segment team will review your source's functionality, catalog metadata, and documentation. If your source is approved, it will appear in the Segment catalog, marked with a "beta" badge for a period of two weeks. After this period, the source is considered generally available.
> Welcome to Segment - glad to have you onboard! This doc serves as a guideline for your team to create best-in-class documentation alongside your amazing product.
6
+
>
7
+
> Here are the guidelines we want you to have in mind when writing out your documentation:
8
+
>
9
+
> - Be succinct and simple in your writing. Reduce text bloat where possible.
10
+
> - Avoid 1st person language as it’s confusing for customers if they don’t know who wrote the docs (Segment or the Partner).
11
+
> - Where pre-reading is required, hyperlink to other more generic parts of Segment’s (or your) documentation.
12
+
>
13
+
> - Screenshots/Images are generally discouraged unless absolutely necessary
14
+
>
15
+
> The below template intends to provide a standardized structure. To submit your documentation, complete the following steps:
16
+
>
17
+
> 1. Clone the `segment-docs` repo locally
18
+
> 2. Create a new branch (e.g., partner-name/destination)
19
+
> 3. Create an `index.md` file in the following path `src/connections/destinations/catalog/{destination-slug}/index.md
20
+
> 4. Copy the template below into your `index.md` file, and edit it to be in line with how your integration operates
21
+
> 5. Add, commit, and push your code to the `segment-docs` repo and submit a pull request
22
+
>
23
+
> If a section does not apply to your integration, feel free to remove. Please don’t create separate sections unless absolutely necessary. In most cases, creating a H3 (###) sub-heading under an existing section is the best option!
24
+
>
25
+
> If you have any questions in the meantime, please reach out to our team at [email protected].
26
+
1
27
---
2
-
# The end name should be similar to `Slack Destination`
3
-
title: <destination_name>
4
-
hide-boilerplate: true
5
-
hide-dossier: true
28
+
29
+
## Template begins here...
30
+
6
31
---
7
32
33
+
## title: <integration_name> Destination
34
+
8
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. -->
9
36
37
+
<!-- In the section above, edit the `title` field. For example, Slack (Actions) Destination -->
38
+
10
39
{% include content/plan-grid.md name="actions" %}
11
40
12
-
<!-- Include a brief description of the destination here, along with a link to your website. -->
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. -->
13
42
14
-
<!-- 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. -->
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.
15
44
16
-
{% include content/ajs-upgrade.md %}
45
+
<!-- Update your company name and support email address. -->
17
46
18
-
<!-- In the section below, explain the value of this actions-based destination. If you don't have a classic version of the destination, remove this section. -->
47
+
This destination is maintained by <integration_name>. For any issues with the destination, [contact their Support team](mailto:support@<integration_name>.com).
19
48
20
-
## Benefits of <destination_name> (Actions)
21
-
22
-
<destination_name> (Actions) provides the following benefits:
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. -->
23
50
24
-
-**Main point 1**. One or two sentences that back up the main point.
25
-
-**Main point 2**. One or two sentences that back up the main point.
51
+
{% include content/ajs-upgrade.md %}
26
52
27
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. -->
28
54
29
55
## Getting started
30
56
31
-
1. From the Segment web app, navigate to **Connections > Catalog** and select the **Destinations** tab within the catalog.
32
-
2.Search for **<destination_name>** and select the destination.
33
-
3. Click **Configure <destintation_name>**.
34
-
4. Select the Source to connect to <destination_name> (Actions).
57
+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
58
+
2.Find the Destinations Actions item in the left navigation, and click it.
59
+
3. Click **Configure <desintation_name>**.
60
+
4. Select an existing Source to connect to <destination_name> (Actions).
35
61
36
62
<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. -->
37
63
@@ -41,4 +67,8 @@ hide-dossier: true
41
67
Additional Context
42
68
43
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.
44
-
-->
70
+
-->
71
+
72
+
---
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.
Copy file name to clipboardExpand all lines: templates/partners/destination-update.md
+48-12Lines changed: 48 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,50 @@
1
+
# 💥 Segment Partner Source Documentation Template
2
+
3
+
> Hi Partners 👋🏼
4
+
>
5
+
> Welcome to Segment - glad to have you onboard! This doc serves as a guideline for your team to create best-in-class documentation alongside your amazing product.
6
+
>
7
+
> Here are the guidelines we want you to have in mind when writing out your documentation:
8
+
>
9
+
> - Be succinct and simple in your writing. Reduce text bloat where possible.
10
+
> - Avoid 1st person language as it’s confusing for customers if they don’t know who wrote the docs (Segment or the Partner).
11
+
> - Where pre-reading is required, hyperlink to other more generic parts of Segment’s (or your) documentation.
12
+
>
13
+
> - Screenshots/Images are generally discouraged unless absolutely necessary
14
+
>
15
+
> The below template intends to provide a standardized structure. To submit your documentation, complete the following steps:
16
+
>
17
+
> 1. Clone the `segment-docs` repo locally
18
+
> 2. Create a new branch (e.g., partner-name/destination)
19
+
> 3. Create an `index.md` file in the following path `src/connections/destinations/catalog/{destination-slug}/index.md
20
+
> 4. Copy the template below into your `index.md` file, and edit it to be in line with how your integration operates
21
+
> 5. Add, commit, and push your code to the `segment-docs` repo and submit a pull request
22
+
>
23
+
> If a section does not apply to your integration, feel free to remove. Please don’t create separate sections unless absolutely necessary. In most cases, creating a H3 (###) sub-heading under an existing section is the best option!
24
+
>
25
+
> If you have any questions in the meantime, please reach out to our team at [email protected].
26
+
1
27
---
2
-
# The end name should be similar to `Slack (Actions) Destination`
3
-
title: <destination_name>
4
-
hide-boilerplate: true
5
-
hide-dossier: true
28
+
29
+
## Template begins here...
30
+
6
31
---
7
32
8
-
<!-- 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 the doc-template-new.md template -->
33
+
## title: <integration_name> Destination
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 -->
9
36
10
37
<!-- In the section above, edit the `title` field. For example, Slack (Actions) Destination -->
11
38
12
39
{% include content/plan-grid.md name="actions" %}
13
40
14
-
<!-- Include a brief description of the destination here, along with a link to your website. -->
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. -->
42
+
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
+
45
+
<!-- Update your company name and support email address. -->
46
+
47
+
This destination is maintained by <integration_name>. For any issues with the destination, [contact their Support team](mailto:support@<integration_name>.com).
15
48
16
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. -->
17
50
@@ -35,23 +68,26 @@ hide-dossier: true
35
68
36
69
## Getting started
37
70
38
-
1. From the Segment web app, navigate to **Connections > Catalog** and select the **Destinations** tab within the catalog.
39
-
2.Search for **<destination_name>** and select the destination.
40
-
3. Click **Configure <destintation_name>**.
41
-
4. Select the Source to connect to <destination_name> (Actions).
71
+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
72
+
2.Find the Destinations Actions item in the left navigation, and click it.
73
+
3. Click **Configure <desintation_name>**.
74
+
4. Select an existing Source to connect to <destination_name> (Actions).
42
75
43
76
<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. -->
44
77
45
78
{% include components/actions-fields.html %}
46
79
47
80
<!--
48
81
Additional Context
49
-
50
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.
51
83
-->
52
84
53
85
<!-- If applicable, add information regarding the migration from a classic destination to an Actions-based version below -->
54
86
55
87
## Migration from the classic <destination_name> destination
56
88
57
-
<!-- Include any pertinent information here. -->
89
+
<!-- Include any pertinent information here. -->
90
+
91
+
---
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.
0 commit comments