From 1f82b605debcdc5eee6772f20fa7f4fb216e2550 Mon Sep 17 00:00:00 2001 From: sanscontext Date: Tue, 17 Dec 2019 15:11:14 -0800 Subject: [PATCH 1/3] add beta message to template --- src/_includes/content/beta.md | 3 ++- src/_layouts/integration.html | 4 ++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/_includes/content/beta.md b/src/_includes/content/beta.md index 1176bc2fcc..90d5570f8e 100644 --- a/src/_includes/content/beta.md +++ b/src/_includes/content/beta.md @@ -1 +1,2 @@ -

This document is about a feature which is in beta.

This means that the {{ include.type }} is in active development, and some functionality may change before it becomes generally available. +### This document is about a feature which is in beta. +This means that the {{ page.integration_type }} is in active development, and some functionality may change before it becomes generally available. diff --git a/src/_layouts/integration.html b/src/_layouts/integration.html index 114388bb41..87a5d244ba 100644 --- a/src/_layouts/integration.html +++ b/src/_layouts/integration.html @@ -53,6 +53,10 @@

+ {% if page.beta %} + {% capture beta-note %}{% include content/beta.md %}{% endcapture %} + {{ beta-note | markdownify }} + {% endif %} {{ content }} {% if page.integration_type == 'destination' %} From 686d60a6ef479add88b70c027e496f90fc753f55 Mon Sep 17 00:00:00 2001 From: sanscontext Date: Wed, 18 Dec 2019 14:14:40 -0800 Subject: [PATCH 2/3] migrate beta items to use beta flag. --- README.md | 1 + src/_includes/content/beta.md | 8 ++++++-- src/connections/destinations/catalog/adikteev/index.md | 6 ++++-- .../destinations/catalog/adobe-target/index.md | 7 ++----- src/connections/destinations/catalog/akita/index.md | 2 +- src/connections/destinations/catalog/all-aboard/index.md | 2 +- .../destinations/catalog/azure-function/index.md | 2 +- .../destinations/catalog/google-cloud-function/index.md | 2 +- src/connections/destinations/catalog/movable-ink/index.md | 6 ++++-- src/connections/destinations/catalog/vitally/index.md | 6 ++++-- .../sources/catalog/cloud-apps/facebook-lead-ads/index.md | 2 +- .../sources/catalog/cloud-apps/marketo/index.md | 3 ++- 12 files changed, 28 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 3c8d7e8ae3..2c71e279a9 100644 --- a/README.md +++ b/README.md @@ -154,6 +154,7 @@ It'll look something like this: Each piece of frontmatter does something special: - `published`: defaults to true. Set this to "false" to prevent Jekyll from rendering an HTML page for this file. Good for when you're working on something in the repo but aren't ready to release it yet, and don't want to use a Draft PR. - `beta`: default false. When true, show an "in beta" warning in the page layout (see the warning in `_includes/content/beta.md`) +- `partner-contact`: defaults to null. Used to change the beta notice to include a partner/owner email address as a mailto link for integrations that aren't Segment-owned. - `hide-feedback`: defaults to false. When true, hide the feedback footer. Good for legal and landing pages. - `hidden`: omits the file from the `sitemap.xml`, adds a `` to the top of the generated HTML file, and drops it from the convenience script for regenerating the nav. - `rewrite`: defaults to false. This is a legacy frontmatter flag that comes from the old `site-docs` repo, and which labels any destination that was rewritten in ~2018 to a standardized template. diff --git a/src/_includes/content/beta.md b/src/_includes/content/beta.md index 90d5570f8e..0e3fa251ca 100644 --- a/src/_includes/content/beta.md +++ b/src/_includes/content/beta.md @@ -1,2 +1,6 @@ -### This document is about a feature which is in beta. -This means that the {{ page.integration_type }} is in active development, and some functionality may change before it becomes generally available. +#### This document is about a {{ page.integration_type }} which is in beta. + +This means that the {{ page.integration_type }} is still in development, there may be bugs to be fixed, and some functionality may change before it becomes generally available. +{% if page.partner-contact %}Have any feedback to help improve the {{ page.title }} or its documentation? Please [let them know](mailto:{{page.partner-contact}})!{% else %}Have any feedback to help us improve the {{ page.title }} or its documentation? Please [let us know](https://segment.com/help/contact)!{% endif %} + +--- diff --git a/src/connections/destinations/catalog/adikteev/index.md b/src/connections/destinations/catalog/adikteev/index.md index 3bc071af67..8b6424fd05 100644 --- a/src/connections/destinations/catalog/adikteev/index.md +++ b/src/connections/destinations/catalog/adikteev/index.md @@ -1,11 +1,13 @@ --- -rewrite: true title: Adikteev Destination +rewrite: true +beta: true +partner-contact: contact@adikteev.com --- This destination is maintained by Adikteev. For any issues with the destination, please [reach out to their team](mailto:contact@adikteev.com). -**NOTE:** The Adikteev Destination is currently in beta, which means that they are still actively developing the destination. This doc was last updated on January 23, 2019. If you are interested in joining their beta program or have any feedback to help improve the Adikteev Destination and its documentation, please let their team know. +**NOTE:** The Adikteev Destination is currently in beta, and this doc was last updated on January 23, 2019. ## Getting Started diff --git a/src/connections/destinations/catalog/adobe-target/index.md b/src/connections/destinations/catalog/adobe-target/index.md index 532ddd8989..bee8ff6be9 100644 --- a/src/connections/destinations/catalog/adobe-target/index.md +++ b/src/connections/destinations/catalog/adobe-target/index.md @@ -1,17 +1,14 @@ --- +title: Adobe Target Destination rewrite: true beta: true -title: Adobe Target Destination --- [Adobe Target](https://www.adobe.com/marketing-cloud/target.html) removes the coding and setup hassles of A/B testing to help you quickly discover which offers, experiences and messages truly engage your visitors. _**NOTE:** Adobe Target is currently in beta, and this doc was last -updated on March 7, 2018. This means that there may still be some bugs for us to -iron out, and we're excited to hear your thoughts. If you are interested in -joining or have any feedback to help us improve the Adobe Target -Destination and its documentation, please [let us know](https://segment.com/help/contact)!_ +updated on March 7, 2018. ## Getting Started diff --git a/src/connections/destinations/catalog/akita/index.md b/src/connections/destinations/catalog/akita/index.md index caa2c549ec..4fad806b5f 100644 --- a/src/connections/destinations/catalog/akita/index.md +++ b/src/connections/destinations/catalog/akita/index.md @@ -3,7 +3,7 @@ beta: true title: Akita Destination --- -*This destination is maintained by Akita* +### This destination is maintained by Akita* ## Getting Started diff --git a/src/connections/destinations/catalog/all-aboard/index.md b/src/connections/destinations/catalog/all-aboard/index.md index 7838df0078..963a1a9150 100644 --- a/src/connections/destinations/catalog/all-aboard/index.md +++ b/src/connections/destinations/catalog/all-aboard/index.md @@ -19,7 +19,7 @@ When you `identify` a user we pass that user's information to All Aboard. You ca All Identify calls must include a user's `email` trait. You must also include a `createdAt` trait to add new customers to All Aboard!. For example: -``` +```js { "type": "identify", "userId": "43", diff --git a/src/connections/destinations/catalog/azure-function/index.md b/src/connections/destinations/catalog/azure-function/index.md index 7a86b55c5f..58da8c0e0f 100644 --- a/src/connections/destinations/catalog/azure-function/index.md +++ b/src/connections/destinations/catalog/azure-function/index.md @@ -8,7 +8,7 @@ Segment makes it easy to send your data to Azure Function (and lots of other des [Azure Function](https://azure.microsoft.com/en-us/services/functions) is a serverless compute service that enables you to run code on-demand without having to explicitly provision or manage infrastructure. Use Azure Functions to run a script or piece of code in response to a variety of events. -_**NOTE:** Azure Function is currently in beta, and this doc was last updated on May 6, 2019. This means that there may still be some bugs for us to iron out and we're excited to hear your thoughts. If you are interested in joining or have any feedback to help us improve the Azure Function Destination and its documentation, please [let us know](https://segment.com/help/contact)!_ +_**NOTE:** Azure Function is currently in beta, and this doc was last updated on May 6, 2019._ # Getting Started diff --git a/src/connections/destinations/catalog/google-cloud-function/index.md b/src/connections/destinations/catalog/google-cloud-function/index.md index e41df826c9..fa891f65ff 100644 --- a/src/connections/destinations/catalog/google-cloud-function/index.md +++ b/src/connections/destinations/catalog/google-cloud-function/index.md @@ -8,7 +8,7 @@ Segment makes it easy to send your data to Google Cloud Function (and lots of ot [Google Cloud Function](https://cloud.google.com/function) is a lightweight compute solution for developers to create single-purpose, stand-alone functions that respond to Cloud events without the need to manage a server or runtime environment. -_**NOTE:** Google Cloud Function is currently in beta, and this doc was last updated on May 6, 2019. This means that there may still be some bugs for us to iron out and we're excited to hear your thoughts. If you are interested in joining or have any feedback to help us improve the Google Cloud Function Destination and its documentation, please [let us know](https://segment.com/help/contact)!_ +_**NOTE:** Google Cloud Function is currently in beta, and this doc was last updated on May 6, 2019._ # Getting Started diff --git a/src/connections/destinations/catalog/movable-ink/index.md b/src/connections/destinations/catalog/movable-ink/index.md index 5c95e34f5b..e12d898224 100644 --- a/src/connections/destinations/catalog/movable-ink/index.md +++ b/src/connections/destinations/catalog/movable-ink/index.md @@ -1,13 +1,15 @@ --- -rewrite: true title: Movable Ink Destination +beta: true +rewrite: true +partner-contact: support@movableink.com --- [Movable Ink](https://movableink.com/) lets email marketers deliver jaw-dropping customer experiences. Our cloud-based software activates any data to generate intelligent content at the moment of open. This destination is maintained by [Movable Ink](https://movableink.com/). If you have any issues, please contact Movable Ink at support@movableink.com. -_**NOTE:** Movable Ink is currently in beta and this doc was last updated on March 14, 2018. This means that there may still be some bugs for us to iron out and we're excited to hear your thoughts. If you are interested in joining or have any feedback to help us improve the Movable Ink Destination and its documentation, and please [let us know](https://segment.com/help/contact)!_ +_**NOTE:** Movable Ink is currently in beta and this doc was last updated on March 14, 2018._ ## Getting Started diff --git a/src/connections/destinations/catalog/vitally/index.md b/src/connections/destinations/catalog/vitally/index.md index 95f113cf7a..11a60675f5 100644 --- a/src/connections/destinations/catalog/vitally/index.md +++ b/src/connections/destinations/catalog/vitally/index.md @@ -1,13 +1,15 @@ --- -rewrite: true title: Vitally Destination +rewrite: true +beta: true +partner-contact: support@vitally.io --- [Vitally](https://vitally.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a customer success platform for B2B SaaS companies that wraps your unified customer data with powerful analytics, alerts, and workflows to help you build successful customers. This destination is maintained by Vitally. For any issues with the destination, please [reach out to their team](mailto:support@vitally.io). -_**NOTE:** Vitally is currently in beta, and this doc was last updated on February 7, 2019. This means that there may still be some bugs for us to iron out and we're excited to hear your thoughts. If you are interested in joining or have any feedback to help us improve the Vitally destination and its documentation, please [let us know](mailto:support@vitally.io)!_ +_**NOTE:** Vitally is currently in beta, and this doc was last updated on February 7, 2019._ ## Getting Started diff --git a/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md b/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md index e29312b557..970b6f9392 100644 --- a/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md +++ b/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md @@ -11,7 +11,7 @@ This is an [Event Cloud Source](https://segment.com/docs/connections/sources/#ev This source is maintained by Facebook. For any issues with the source, you may [contact their team](mailto:supportemail@email.com). -_**NOTE:** Facebook Lead Ads is currently in beta and this doc was last updated on January 07, 2019. This means that there may still be some bugs for us to iron out and we're excited to hear your thoughts. If you are interested in joining or have any feedback to help us improve the Facebook Lead Ads Destination and its documentation, and please [let us know](https://segment.com/help/contact)!_ +_**NOTE:** Facebook Lead Ads is currently in beta and this doc was last updated on January 07, 2019._ ## Getting Started diff --git a/src/connections/sources/catalog/cloud-apps/marketo/index.md b/src/connections/sources/catalog/cloud-apps/marketo/index.md index 3f7ba7d5e5..9593b40afb 100644 --- a/src/connections/sources/catalog/cloud-apps/marketo/index.md +++ b/src/connections/sources/catalog/cloud-apps/marketo/index.md @@ -2,6 +2,7 @@ title: Marketo Source rewrite: true source-type: object +beta: true --- [Marketo](https://www.marketo.com/) is a leader in marketing automation. Using our Marketo source, we will load your campaigns, emails, leads and other collections into your data warehouse. @@ -10,7 +11,7 @@ This will allow you to write SQL to analyze your analyze your email marketing ca This is an [Object Cloud Source](https://segment.com/docs/connections/sources/#object-cloud-sources) which can export data from its third party tool and import it directly into your Segment warehouse. -_**NOTE:** Marketo is currently in beta and this doc was last updated on April 30, 2018. This means that there may still be some bugs for us to iron out and we're excited to hear your thoughts. If you have any feedback to help us improve the Marketo Source and its documentation, and please [let us know](https://segment.com/help/contact)!_ +_**NOTE:** Marketo is currently in beta and this doc was last updated on April 30, 2018._ ## Getting Started From 9537fcba688cbe2bd34851ff659f73f701f01a5e Mon Sep 17 00:00:00 2001 From: sanscontext Date: Wed, 18 Dec 2019 14:31:35 -0800 Subject: [PATCH 3/3] two more - need to do other things now --- src/connections/destinations/catalog/auryc/index.md | 8 ++++++-- src/connections/destinations/catalog/xtremepush/index.md | 6 ++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/src/connections/destinations/catalog/auryc/index.md b/src/connections/destinations/catalog/auryc/index.md index 87672c0488..0932ada5a7 100644 --- a/src/connections/destinations/catalog/auryc/index.md +++ b/src/connections/destinations/catalog/auryc/index.md @@ -1,12 +1,16 @@ --- -rewrite: true title: Auryc Destination +rewrite: true +beta: true +partner-contact: segment@auryc.com --- [Auryc](https://www.auryc.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a client-side journey intelligence platform that surfaces real-time insights with powerful visual context across all of your digital ecommerce journeys. Auryc helps enterprises find and resolve the customer journey issues that directly impact conversions and customer satisfaction. This source is maintained by Auryc. For any issues with the destination, please [reach out to their team](mailto:segment@auryc.com). -_**NOTE:** The Auryc Destination is currently in beta, which means that they are still actively developing the destination. This doc was last updated on April 25, 2019. If you are interested in joining their beta program or have any feedback to help improve the Auryc Destination and its documentation, please [let their team know](mailto:segment@auryc.com)!_ It also means that, for the time being, there is a longer delay for us to deploy it to your analytics.js after you enable; expect about 24 hours for it to render on your site. +_**NOTE:** The Auryc Destination is currently in beta, and this doc was last updated on April 25, 2019. If you are interested in joining their beta program or have any feedback to help improve the Auryc Destination and its documentation, please [let their team know](mailto:segment@auryc.com)!_ + +It also means that, for the time being, there is a longer delay for us to deploy it to your analytics.js after you enable; expect about 24 hours for it to render on your site. ## Getting Started diff --git a/src/connections/destinations/catalog/xtremepush/index.md b/src/connections/destinations/catalog/xtremepush/index.md index 7c9f57710b..6daf96fbb2 100644 --- a/src/connections/destinations/catalog/xtremepush/index.md +++ b/src/connections/destinations/catalog/xtremepush/index.md @@ -1,12 +1,14 @@ --- -rewrite: true title: Xtremepush Destination +rewrite: true +beta: true +partner-contact: mailto:support@xtremepush.com) --- [Xtremepush](https://xtremepush.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a complete digital engagement platform. Empowering global brands to create personalised, real-time experiences for their customers across mobile, web, email, SMS and social. Xtremepush's clients are increasing revenue through data-driven, contextually-relevant interactions. The software is flexible, reliable and quick to deploy, backed up by a team of expert strategists and technical support. This destination is maintained by Xtremepush. For any issues with the destination, please [reach out to their team](mailto:support@xtremepush.com). -_**NOTE:** The Xtremepush Destination is currently in beta, which means that they are still actively developing the destination. This doc was last updated on April 05, 2019. If you are interested in joining their beta program or have any feedback to help improve the Xtremepush Destination and its documentation, please [let their team know](mailto:support@xtremepush.com)!_ +_**NOTE:** The Xtremepush Destination is currently in beta, and this doc was last updated on April 05, 2019. If you are interested in joining their beta program, please [let their team know](mailto:support@xtremepush.com)!_ ## Getting Started