Skip to content

Commit 1d1403a

Browse files
author
Thomas Gilbert
committed
cleanup template and standardize getting started sections
1 parent afec35d commit 1d1403a

File tree

4 files changed

+6
-13
lines changed

4 files changed

+6
-13
lines changed

templates/partners/destination-new.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,4 @@ This destination is maintained by <integration_name>. For any issues with the de
6363
> 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.
6464
6565

66-
---
67-
6866
> (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.

templates/partners/destination-update.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,4 @@ This destination is maintained by <integration_name>. For any issues with the de
8282

8383
> (delete after reading) If applicable, add information regarding the migration from a classic destination to an Actions-based version below.
8484
85-
---
86-
8785
> (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.

templates/partners/direct-destination.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ This destination is maintained by YOURINTEGRATION. For any issues with the desti
4545

4646
> Include clear, succinct steps including hyperlinks to where customers can locate their API Key in your app. If there is an expected delay for a customer to see data flow into your integration, please make that explicit.
4747
48-
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
49-
2. Search for "YOURINTEGRATION" in the Destinations Catalog, and select the "YOURINTEGRATION" destination.
48+
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "YOURINTEGRATION"
49+
2. Select "YOURINTEGRATION" and click **Add Destination**
5050
3. Choose which Source should send data to the "YOURINTEGRATION" destination.
5151
4. Go to the [YOURINTEGRATION dashboard](https://YOURINTEGRATION.com/dashboard){:target="_blank"}, find and copy the "API key".
5252
5. Enter the "API Key" in the "YOURINTEGRATION" destination settings in Segment.
@@ -108,6 +108,5 @@ analytics.track('Login Button Clicked')
108108

109109
Segment sends Track calls to YOURINTEGRATION as a `track` event.
110110

111-
---
112111

113-
> 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 via your designated Slack Channel and we’ll respond with updates when we publish it and your integration!
112+
> (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 via your designated Slack Channel and we’ll respond with updates when we publish it and your integration!

templates/partners/source.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ This source is maintained by <integration_name>. For any issues with the source,
4545
4646
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**.
4747
2. Search for "<integration_name>" in the Sources Catalog, select <integration_name>, and click **Add Source**.
48-
3. On the next screen, give the Source a nickname configure any other settings.
48+
3. On the next screen, give the Source a name configure any other settings.
4949

50-
- The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev).
50+
- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev).
5151

5252
4. Click **Add Source** to save your settings.
5353
5. Copy the Write key from the Segment UI.
@@ -101,6 +101,4 @@ Log into your downstream tools and check to see that your events appear as expec
101101

102102
If there are any issues with how the events are arriving to Segment, [contact the <integration_name> support team](mailto:support@<integration_name>.com).
103103

104-
---
105-
106-
> 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.
104+
> (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.

0 commit comments

Comments
 (0)