Skip to content

Commit dfb656c

Browse files
markzegarellirchinn1bot-docsteam
authored
Release 22.7.2 (#2510)
* Doc439-Google-Adwords-Remarketing-Lists * [netlify-build] * Doc-457-Batch-Destinations-Sync-Frequency * Some lightweight grammar checks (#2505) * Some lightweight grammar checks * update version * check an updated file * Update relative link check * only annotate modified lines * Added yaml file for integration slug overrides (#2502) * Enabled destination metadata block for Actions destinations (#2501) * Updated TikTok Conversions instructions (#2508) * Updated TikTok Conversions instructions * add better description Co-authored-by: rchinn-segment <[email protected]> Co-authored-by: Segment Docs Robot <[email protected]>
1 parent 6d104bb commit dfb656c

File tree

47 files changed

+282
-76
lines changed

Some content is hidden

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

47 files changed

+282
-76
lines changed

‎.github/.vale.ini

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
StylesPath = .github/styles
2+
3+
Vocab = Docs
4+
5+
[*.md]
6+
BasedOnStyles = segment
7+
TokenIgnores = ({% .* %})

‎.github/Vocab/Docs/accept.txt

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
allowlist
2+
Appboy
3+
blocklist
4+
boolean
5+
CloudFront
6+
Cocoapods
7+
Gradle
8+
HTTP
9+
http
10+
HTTPS
11+
https
12+
Javadoc
13+
Javadocs
14+
Javascript
15+
Kameleoon
16+
Kissmetrics
17+
Littledata
18+
Middleware
19+
middleware
20+
Mixpanel
21+
Okta
22+
performant
23+
Preact
24+
Shopify
25+
Totango
26+
Twilio
27+
Vero
28+
WebKit
29+
Wootric
30+
Zendesk
31+
iOS
32+
ios
33+
Dev
34+
ga
35+
(?:G|g)tag
36+
(?:P|p)ageviews?\b
37+
(?:R|r)emarketing
38+
Doubleclick
39+
(?:C|c)annonical
40+
(?:U|u)rls?\b
41+
Optimizely
42+
Omnichannel
43+
namespace
44+
upsert
45+
viewability
46+
measurability
47+
Lightbox
48+
gmail
49+
(?:P|p)endo
50+
(?:K|k)laviyo
51+
(?:U|u)nmaps?\b
52+
(?:U|u)nlinks?\b
53+
(?:P|p)ostgres
54+
Smartly
55+
Hubspot
56+
Friendbuy
57+
Chargebee
58+
(?:L|l)ookback
59+
Subnet

‎.github/Vocab/Docs/reject.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
functionality
2+
e.g.
3+
i.e.
4+
signup
5+
setup
6+
login

‎.github/Vocab/Marketing/accept.txt

Whitespace-only changes.

‎.github/Vocab/Marketing/reject.txt

Whitespace-only changes.

‎.github/styles/segment/Latin.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
extends: substitution
2+
message: "Use '%s' instead of '%s'."
3+
# link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words
4+
ignorecase: true
5+
level: error
6+
nonword: true
7+
8+
action:
9+
name: replace
10+
swap:
11+
'\b(?:eg|e\.g\.)[\s,]': for example
12+
'\b(?:ie|i\.e\.)[\s,]': that is, for example

‎.github/styles/segment/exclamation.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
extends: substitution
2+
message: "Please use '%s' instead of '%s'."
3+
link: https://docs.microsoft.com/en-us/style-guide/punctuation/exclamation-points
4+
level: warning
5+
swap:
6+
'\w!\s': '\.'

‎.github/styles/segment/links.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
extends: existence
2+
message: "Write meaningful link text."
3+
link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses
4+
level: warning
5+
raw:
6+
- '\[?here\]\('

‎.github/styles/segment/relative-url.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
extends: existence
2+
message: 'Link to Segment docs "%s" must be relative.'
3+
level: warning
4+
scope: raw
5+
raw:
6+
- '\[.+\]\(https://(www.)?segment.com/docs.*\)'
7+

‎.github/styles/segment/subs.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
extends: substitution
2+
message: Please use '%s' instead of '%s'
3+
level: error
4+
ignorecase: true
5+
swap:
6+
blacklist: blocklist
7+
whitelist: allowlist
8+
utilize: use
9+
utilizes: uses
10+
utilizing: using
11+
leverage: use
12+
leverages: uses
13+
leveraging: using
14+
via: through, or using
15+
drop in: enter

‎.github/styles/segment/third-person-specific.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
extends: existence
2+
message: "Avoid using first-person like '%s'. Use Segment, a product name, or the other company name."
3+
# link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural
4+
level: warning
5+
ignorecase: true
6+
7+
tokens:
8+
- we
9+
- we'(?:ve|re)
10+
- ours?
11+
- our
12+
- us
13+
- let's
14+
# - their

‎.github/workflows/grammar-lint.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Linting
2+
on: [push]
3+
4+
jobs:
5+
prose:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Checkout
9+
uses: actions/checkout@master
10+
11+
- name: Vale
12+
uses: errata-ai/vale-action@master
13+
with:
14+
# Optional
15+
# styles: |
16+
# https://github.com/errata-ai/Microsoft/releases/latest/download/Microsoft.zip
17+
# https://github.com/errata-ai/write-good/releases/latest/download/write-good.zip
18+
19+
# Optional
20+
# config: https://raw.githubusercontent.com/errata-ai/vale/master/.vale.ini
21+
22+
# Optional
23+
files: __onlyModified
24+
onlyAnnotateModifiedLines: true
25+
env:
26+
# Required, set by GitHub actions automatically:
27+
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
28+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

‎scripts/catalog_papi.js

+12-25
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ require('dotenv').config();
1212
PAPI_URL = "https://api.segmentapis.com"
1313

1414
const regionalSupport = yaml.load(fs.readFileSync(path.resolve(__dirname, `../src/_data/regional-support.yml`)))
15+
const slugOverrides = yaml.load(fs.readFileSync(path.resolve(__dirname, `../src/_data/catalog/slugs.yml`)))
1516

1617

1718
const slugify = (displayName) => {
@@ -23,13 +24,16 @@ const slugify = (displayName) => {
2324
.replace(/[\(\)]/g, '')
2425
.replace('.', '-')
2526

26-
if (slug === '-net') slug = 'net'
27-
if (slug === 'talon-one') slug = 'talonone'
28-
if (slug === 'roku-alpha') slug = 'roku'
29-
if (slug === 'shopify-by-littledata') slug = 'shopify-littledata'
30-
if (slug === 'talon-one') slug = 'talonone'
31-
if (slug == 'google-adwords-remarketing-lists-customer-match') slug = 'adwords-remarketing-lists'
32-
if (slug == 'canny-classic') slug = 'canny'
27+
for (key in slugOverrides) {
28+
let original = slugOverrides[key].original
29+
let override = slugOverrides[key].override
30+
31+
if (slug == original) {
32+
console.log(original+" -> "+override)
33+
slug = override
34+
}
35+
}
36+
3337
return slug
3438
}
3539

@@ -329,26 +333,8 @@ const updateDestinations = async () => {
329333
destinations.forEach(destination => {
330334
let regional = ['us-west']
331335

332-
// We need to be able to keep the system slug in some cases.
333-
const slugOverrides = ['actions-google-enhanced-conversions', 'actions-google-analytics-4', 'actions-facebook-conversions-api', 'actions-friendbuy-cloud', 'sprig-web', 'google-analytics']
334336
let slug = slugify(destination.name)
335-
if (slugOverrides.includes(destination.slug)) {
336-
slug = destination.slug
337-
}
338337

339-
340-
// Flip the slug of Actions destinations
341-
const actionsDests = [
342-
'amplitude-actions',
343-
'slack-actions',
344-
'fullstory-actions',
345-
'friendbuy-actions'
346-
]
347-
348-
if (actionsDests.includes(slug)) {
349-
const newSlug = slug.split('-')
350-
slug = newSlug[1] + '-' + newSlug[0]
351-
}
352338
if (regionalDestinations.includes(slug)) {
353339
regional.push('eu-west')
354340
}
@@ -569,3 +555,4 @@ const updateWarehouses = async () => {
569555
updateSources()
570556
updateWarehouses()
571557
updateDestinations()
558+

‎src/_data/catalog/destination_categories.yml

+1-1
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 2022-02-14
2+
# destination categories last updated 2022-02-15
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

‎src/_data/catalog/destinations.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2022-02-14
2+
# destination data last updated 2022-02-15
33
items:
44
- destination_id: 60b5d0a01f3726b85dc05aab
55
display_name: 2mee

‎src/_data/catalog/regional-supported.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL
2-
# Last updated 2022-02-14
2+
# Last updated 2022-02-15
33
warehouses:
44
- id: WcjBCzUGff
55
display_name: Azure SQL Data Warehouse
@@ -51,7 +51,7 @@ warehouses:
5151
- us-west
5252
- eu-west
5353
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
54-
# source cateogries last updated 2022-02-14
54+
# source cateogries last updated 2022-02-15
5555
items:
5656
- display_name: A/B Testing
5757
slug: a-b-testing

‎src/_data/catalog/slugs.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Manual overrides of our catalog slug generation function
2+
3+
- original: "-net"
4+
override: "net"
5+
- original: "talon-one"
6+
override: "talonone"
7+
- original: "roku-alpha"
8+
override: "roku"
9+
- original: "shopify-by-littledata"
10+
override: "shopify-littledata"
11+
- original: "google-adwords-remarketing-lists-customer-match"
12+
override: "adwords-remarketing-lists"
13+
- original: "canny-classic"
14+
override: "canny"
15+
- original: "amplitude-actions"
16+
override: "actions-amplitude"
17+
- original: "slack-actions"
18+
override: "actions-slack"
19+
- original: "fullstory-actions"
20+
override: "actions-fullstory"
21+
- original: "google-enhanced-conversions"
22+
override: "actions-google-enhanced-conversions"
23+
- original: "google-analytics-4"
24+
override: "actions-google-analytics-4"
25+
- original: "facebook-conversions-api-actions"
26+
override: "actions-facebook-conversions-api"
27+
- original: "friendbuy-cloud-destination"
28+
override: "actions-friendbuy-cloud"
29+
- original: "sprig-actions"
30+
override: "sprig-web"
31+
- original: "google-universal-analytics"
32+
override: "google-analytics"

‎src/_data/catalog/source_categories.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# source cateogries last updated 2022-02-14
2+
# source cateogries last updated 2022-02-15
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

‎src/_data/catalog/sources.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# sources last updated 2022-02-14
2+
# sources last updated 2022-02-15
33
items:
44
- id: 8HWbgPTt3k
55
display_name: .NET

‎src/_includes/content/destination-footer.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ You can send computed traits and audiences generated using [Segment Personas](/d
1515
For user-property destinations, an [identify](/docs/connections/spec/identify/) call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Personas sends an Identify call with the property `order_completed_last_30days: true`. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Personas sets that value to `false`.
1616

1717
When you first create an audience, Personas sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.
18-
18+
{% unless show-sync-disclaimer == true %}
19+
{% include content/sync-frequency-note.md %}
20+
{% endunless %}
1921
{% endunless %}
2022

2123
{% endif %}

‎src/_includes/content/sync-frequency-note.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<div class="premonition info"><div class="fa fa-info-circle"></div><div class="content"><p class="header">Real-time to batch destination sync frequency</p><p> Note that real-time audience syncs to {{page.title| replace: "Destination", " "}} might take two to three hours.</p>
2+
3+
</div></div>

‎src/connections/destinations/catalog/actions-amplitude/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Amplitude (Actions) Destination
33
hide-boilerplate: true
4-
hide-dossier: true
4+
hide-dossier: false
55
---
66
{% include content/plan-grid.md name="actions" %}
77

‎src/connections/destinations/catalog/actions-braze-cloud/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Braze Cloud Mode (Actions) Destination
33
hide-boilerplate: true
4-
hide-dossier: true
4+
hide-dossier: false
55
hidden: true
66
---
77
{% include content/plan-grid.md name="actions" %}

‎src/connections/destinations/catalog/actions-braze-web/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Braze Web Mode (Actions) Destination
33
hide-boilerplate: true
4-
hide-dossier: true
4+
hide-dossier: false
55
hidden: true
66
---
77
{% include content/plan-grid.md name="actions" %}

‎src/connections/destinations/catalog/actions-customer-io/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Customer.io (Actions) Destination
33
hide-personas-partial: true
4-
hide-boilerplate: true
4+
hide-boilerplate: false
55
hide-dossier: true
66
---
77
{% include content/plan-grid.md name="actions" %}

‎src/connections/destinations/catalog/actions-facebook-conversions-api/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Facebook Conversions API (Actions)
33
strat: facebook
44
hide-boilerplate: true
5-
hide-dossier: true
5+
hide-dossier: false
66
---
77

88
Facebook Conversions API (Actions) enables advertisers to send events from their servers directly to Facebook. Server-side events link to Facebook Pixel events, and process like browser pixel events. This means that server-side events are used in measurement, reporting, and optimization, just like browser pixel events.

‎src/connections/destinations/catalog/actions-friendbuy-cloud/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Friendbuy Cloud Mode (Actions) Destination
33
hide-boilerplate: true
4-
hide-dossier: true
4+
hide-dossier: false
55
hidden: false
66
---
77

‎src/connections/destinations/catalog/actions-friendbuy/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Friendbuy Web Mode (Actions) Destination
33
hide-boilerplate: true
4-
hide-dossier: true
4+
hide-dossier: false
55
hidden: false
66
---
77

‎src/connections/destinations/catalog/actions-fullstory/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: FullStory (Actions)
33
hide-boilerplate: true
4-
hide-dossier: true
4+
hide-dossier: false
55
---
66
{% include content/plan-grid.md name="actions" %}
77

0 commit comments

Comments
 (0)