Skip to content

Commit 5ca162f

Browse files
authored
Merge branch 'develop' into MStephen024-patch-2
2 parents a8d115a + 62a79dc commit 5ca162f

File tree

997 files changed

+80739
-41742
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

997 files changed

+80739
-41742
lines changed

CODEOWNERS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ CODEOWNERS @segmentio/segment-doc-team
4141

4242

4343
# Engage
44-
/src/engage/ @pwseg @rchinn-segment
44+
/src/engage/ @pwseg
4545

4646
# Unify
47-
/src/unify @rchinn-segment
47+
/src/unify @pwseg
4848

4949
# Protocols owners
5050
/src/protocols @forstisabella

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,16 @@ Sources pages check if the source is a cloud-app, then include information about
7777

7878
Content with in each `.md` file is markdown. For information about styling, and available extensions, see `_src/utils/formatguide.md` or the live version [here](https://segment.com/docs/utils/formatguide).
7979

80+
## Building a preview
81+
82+
Netlify allows you to build a preview environment on any PR you create in GitHub. This is helpful when you want to send out a review, and the formatting and design are important to those reviewers.
83+
84+
To build a preview site, add `[netlify-build]` to a commit message on your PR. Here's an example of what the preview build will look like:
85+
86+
https://github.com/segmentio/segment-docs/pull/6051#issuecomment-1942723573
87+
88+
You can rebuild the preview by adding a new commit with `[netlify-build]` in the commit message.
89+
8090
### Front matter
8191

8292
Repository Markdown files often contain front matter metadata, which you'll find at the top of the file. These front matter variables instruct Jekyll how to build and render the page as HTML.
@@ -112,3 +122,4 @@ Front matter variables have unique functions, including the following:
112122
- `redirect_from`: Defaults to null. Takes an array of URLs from the front matter in a file, and generates a "stub" page at each URL at build-time. Each stub file redirects to the original file. Use the path from the root of the content directory, for example `/connections/destinations/catalog/` rather than `/docs/connections/destinations/catalog/`. **Note** We are mostly using NGINX redirects for SEO purposes. Approximately quarterly, we'll collect these and add them to NGINX.
113123
- `seo-changefreq`: default: `weekly `. Use the values [in the sitemap spec](https://www.sitemaps.org/protocol.html#xmlTagDefinitions). - sets the `changefreq` tag in the sitemap.xml generator, which tells search crawlers how often to check back.
114124
- `seo-priority`: values from `1.0` to `0.1`, default: `0.5 `. Sets the `Priority` tag in the sitemap
125+
- `engage`: defaults to false. Hides the connection modes table and adds a note in the Destination Info box that reads "This destination is **only** compatible with [Twilio Engage](https://segment.com/docs/engage/)."

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,25 @@ This repository contains the documentation website code and source files for htt
1111

1212
In this article, find information about:
1313

14+
- Prerequisites
1415
- Contributing
1516
- A list of READMEs
1617
- Code of conduct
1718
- License agreement
1819

20+
## Prerequisites
21+
The following are a list of prerequisites you may want to consider downloading and installing to successfully contribute to the Segment docs repo:
22+
23+
1. Download and install a source code editor like [Visual Studio Code](https://code.visualstudio.com/download).
24+
1. Download and install a package manager such as [Homebrew](https://brew.sh/) to install new software.
25+
1. [Create an account on GitHub](https://docs.github.com/en/get-started/quickstart/creating-an-account-on-github) if you don't have one already, or sign in with your existing GitHub account.
26+
1. Add the GitHub extension to your editor (in VSC: https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github).
27+
1. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the Segment docs repo.
28+
1. Download and install the latest version of [node.js](https://nodejs.org/en/download). Consider using a version manager such as [ASDF](https://github.com/asdf-vm/asdf) or [nvm-windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows).
29+
1. Install dependencies
30+
`npm i`
31+
1. Install [vale](https://docs.errata.ai/vale/install). An [ASDF plugin](https://github.com/osg/asdf-vale) is also available.
32+
1933
## Contributing
2034

2135
The Segment docs team accepts contributions in the form of issues and pull requests.

ignore-links.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,10 @@ https://segment.com/docs/connections/sources/catalog/cloud-apps/snowflake/
7171
https://segment.com/docs/connections/destinations/catalog/adobe-target-cloud-mode/
7272
https://segment.com/docs/connections/destinations/catalog/adobe-target-web/
7373
https://segment.com/docs/connections/destinations/catalog/google-ads-remarketing-lists/
74+
https://compose.aampe.com/configure/integrations
75+
https://everboarding.trybento.co/data
76+
https://app.getcorrelated.com/integrations
77+
https://app.launchdarkly.com/default/production/debugger/goals
78+
https://www.app.metricstory.ai/account/apikeys
79+
https://app.unstack.com/login
80+
https://github.com/fubotv/segment-analytics-android/pull/1

scripts/catalog/updateDestinations.js

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,11 @@ const updateDestinations = async () => {
102102
return clonedObj;
103103
};
104104

105-
// I honestly don't remember why I did this.
106-
// I think someone wanted to mention support for the Screen method to whatever destination that is
105+
// The screen method is not returned as a method from the public API, so if a destination wants to
106+
// show screen as a supported method in `destination-dossier.html` then add the destination id here
107+
const destinationsThatSupportScreen = ['63e42b47479274407b671071', '65ccc6147108efc0cf5c6fe1']
107108
destination.supportedMethods.screen = false;
108-
if (destination.id == '63e42b47479274407b671071') {
109+
if (destinationsThatSupportScreen.includes(destination.id)) {
109110
destination.supportedMethods.screen = true;
110111
}
111112

@@ -141,7 +142,8 @@ const updateDestinations = async () => {
141142
connection_modes,
142143
settings,
143144
actions,
144-
presets
145+
presets,
146+
partnerOwned: destination.partnerOwned
145147
};
146148

147149
// Add the updated destination to the destinationsUpdated array

scripts/catalog/utilities.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,4 +172,4 @@ exports.getCatalog = getCatalog;
172172
exports.getConnectionModes = getConnectionModes;
173173
exports.isCatalogItemHidden = isCatalogItemHidden;
174174
exports.sanitize = sanitize;
175-
exports.doesCatalogItemExist = doesCatalogItemExist;
175+
exports.doesCatalogItemExist = doesCatalogItemExist;

src/_data/actions/braze-cloud.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ actions:
173173
description: Set to true to use the Braze API in "Update Only" mode.
174174
default: false
175175
- action: Track Purchase
176-
blurb: Track Purchase sends Braze a Track Purchase call when the destination recieves any event that matches the specified name.
176+
blurb: Track Purchase sends Braze a Track Purchase call when the destination receives any event that matches the specified name.
177177
fields:
178178
- name: Time
179179
description: The timestamp of when the event occured.

src/_data/actions/braze-web.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ actions:
221221
description: Set to true to use the Braze API in "Update Only" mode.
222222
default: false
223223
- action: Track Purchase
224-
blurb: Track Purchase sends Braze a Track Purchase call when the destination recieves any event named `Order Completed`.
224+
blurb: Track Purchase sends Braze a Track Purchase call when the destination receives any event named `Order Completed`.
225225
fields:
226226
- name: Time
227227
description: The timestamp of when the event occured.

src/_data/catalog/beta_sources.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# This file is manually generated.
2+
# Add the ids of beta sources to give them a beta flag on the catalog page.
3+
# (/docs/connections/sources/catalog)
4+
5+
- 8aF29Uq46F
6+
- QhEUZnE5uF
7+
- Zd5BXedXsa
8+
- glwy6LwOVo
9+
- 3x07B5Dn5h
10+
- DY0B0Q2Gce
11+
- n8YgCndi75
12+
- 9TYqEh3nMe
13+
- xqegKCQA0W
14+
- L9XPA9n2Mc
15+
- kpDbTUR9oD
16+
- wFC7PGNwGR
17+
- vMEJCURfHh
18+
- EjYD7n6dOa
19+
- VETiUX9u66
20+
- NC2jsEkA8Y
21+
- o9OyD6xsVJ
22+
- ODf0vA6dcH
23+
- YWOGVbyMVz
24+
- CwGEZ7eCcA
25+
- xeZMgSrtAQ
26+
- VShGHAfvlr

src/_data/catalog/destination_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination categories last updated 2023-09-28
2+
# destination categories last updated 2024-05-30
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

0 commit comments

Comments
 (0)