Skip to content

Commit e13b2bb

Browse files
markzegarellirchinn1pwseg
authored
Engage ga (#590)
* Account-audiences article * Debugger * ID Res eComm example * Audiences Overview * Computed Traits * Identity Resolution Overview * Identity Resolution Onboarding * Profiles Space Setup * ID Resolution Settings * Journeys Key Terms * Engage GDPR * ID Res use cases * Nav stubs * Build a Journey * Audiences and space setup updates * Journeys FAQ Best Practices * Update computed traits location * Send Data * product limits * Sql traits * add example csv files * Using Engage Data * Engage and Warehouses * Profile API * Audiene Organization * Quickstart * FAQs * Journeys use cases * Remove Personas screenshot * Journeys Logic * Journeys Overview and Warehouses update * Profiles External IDs * Space setup nav update * use standard layout * Use standard search, refactor overview * Profile API fixes * Fixing profiles nav * Match user_id value with screenshot * Use Cases cleanup * CSV Uploader updates * Deep clean * move CSV upload * Engage Intro and Identity Warehouse * Link and nav fixes * forgot to save this one * Remove Essentials limits * Update nav * More nav updates * More nav updates * Plan Grid work to support Engage SKUs * Add Profile API Limits to nav * replacing instances * Add plan details as metadata * Personas replacements * Personas replacements * Add recent externalID updates to Engage branch * Move journey analytics * and add it to the nav * remove old layout * hide empty docs from nav * Minor email and SMS template edits * CSV upload navigation updates * file and nav cleanup * Hide internal logo * RIP Personas * link fixes * Hide empty articles * quickstart in the nav * Update Engage icon and blurb link * Profiles Overview * Update Engage blurb * Update Engage blurb * get onboard * FAQs split * Add Onboarding Redirect * Add Channels product limit * Profiles GDPR * Profiles Quickstart split * Add Engage Settings Content * Add split content to sidenav * fixed broken links * Beta check and unpublish contact page * Quickstart updates * Remove Engage Support References * Hide Engage Settings Pages * Update instance of Engage Pro to Premier and link fixes * Relink images * additional link fixes * Add Journeys Step Types Page [DOC-587] (#589) * Add Journeys Step Types Page DOC-587 * Vale Sentence Case Fixes DOC-587 * Update Journey Re-entry FAQ Co-authored-by: rchinn-segment <[email protected]> Co-authored-by: pwseg <[email protected]> Co-authored-by: pwseg <[email protected]>
1 parent e6b1dd2 commit e13b2bb

File tree

350 files changed

+2093
-3866
lines changed

Some content is hidden

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

350 files changed

+2093
-3866
lines changed

.github/styles/Vocab/Docs/accept.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
(?:R|r)emarketing
1515
(?:U|u)nlinks?\b
1616
(?:U|u)nmaps?\b
17+
(?:U|u)ploader
1718
(?:U|u)rls?\b
1819
adset
1920
Adwords
@@ -42,6 +43,7 @@ datetime
4243
deeplink
4344
Dev
4445
Doubleclick
46+
enablement
4547
endcapture
4648
endfor
4749
endif
@@ -81,6 +83,7 @@ Mailmodo
8183
markdownify
8284
Marketo
8385
Matcha
86+
matchers
8487
measurability
8588
middleware
8689
Middleware
@@ -94,8 +97,10 @@ Optimizely
9497
param(:?s)
9598
Pardot
9699
performant
100+
Pinterest
97101
Preact
98102
Qualtrics
103+
Responsys
99104
Rokt
100105
Selligent
101106
Sendgrid

js/algolia/index.js

Lines changed: 0 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ const algoliaInsightsPlugin = createAlgoliaInsightsPlugin({ insightsClient });
2424

2525
// define locations to separate invocation for mobile and desktop
2626
const locations = ['#autocomplete','#autocomplete-mobile'];
27-
const engage_locations = ['#engage-autocomplete']
2827

2928
function initAutocomplete(item){
3029
const search = autocomplete({
@@ -106,90 +105,4 @@ function initAutocomplete(item){
106105

107106
}
108107

109-
function initEngageAutocomplete(item){
110-
const search = autocomplete({
111-
container: item,
112-
placeholder: "Search the Twilio Engage documentation",
113-
debug: false,
114-
openOnFocus: false,
115-
keyboardShortcuts: ['s', 191],
116-
plugins: [algoliaInsightsPlugin,],
117-
detachedMediaQuery:'none',
118-
getSources( {query} ) {
119-
return [
120-
{
121-
sourceId: 'articles',
122-
getItemUrl({ item }){
123-
if (item.anchor != null) {
124-
var itemUrl = '/docs'+item.url+"#" + item.anchor;
125-
} else {
126-
var itemUrl = '/docs'+item.url;
127-
}
128-
return itemUrl;
129-
},
130-
getItems() {
131-
return getAlgoliaResults({
132-
searchClient,
133-
queries: [
134-
{
135-
indexName: 'segment-docs',
136-
query,
137-
params: {
138-
hitsPerPage: 7,
139-
facetFilters: ['hidden:-true'],
140-
clickAnalytics: true,
141-
},
142-
},
143-
],
144-
});
145-
},
146-
templates: {
147-
item({ item, createElement }){
148-
if (item.anchor != null) {
149-
var anchorLink = "#" + item.anchor;
150-
} else {
151-
var anchorLink = "";
152-
}
153-
154-
if (item.engage){
155-
var engage = "<span class='engage-pill'>Engage</span>"
156-
}
157-
return createElement('div',{
158-
dangerouslySetInnerHTML: {
159-
__html: `<a class="aa-link" href="/docs${item.url}${anchorLink}">
160-
<p class="aa-title" >${highlightHit({hit: item, attribute: 'title'})} ${engage}</h3>
161-
<p class="aa-content">${highlightHit({hit: item, attribute: 'content'})}</p></a>`
162-
}
163-
})
164-
},
165-
noResults() {
166-
return html `<p class="aa-content">No results for <strong>${query}</strong></p>`;
167-
}
168-
},
169-
170-
},
171-
];
172-
},
173-
navigator: {
174-
navigate({ itemUrl }) {
175-
window.location.assign(itemUrl);
176-
},
177-
navigateNewTab({ itemUrl }) {
178-
const windowReference = window.open(itemUrl, '_blank', 'noopener');
179-
180-
if (windowReference) {
181-
windowReference.focus();
182-
}
183-
},
184-
navigateNewWindow({ itemUrl }) {
185-
window.open(itemUrl, '_blank', 'noopener');
186-
},
187-
},
188-
});
189-
190-
}
191-
if (loc.startsWith("/docs/engage")) {
192-
engage_locations.forEach(initEngageAutocomplete)
193-
} else {
194108
locations.forEach(initAutocomplete);
195-
}

netlify.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
ignore = "./scripts/ignore.sh"
1313

1414
[context.branch-deploy]
15-
command = "jekyll algolia && yarn build"
15+
command = "yarn build"
1616
# ignore = "./scripts/ignore.sh"
1717

1818
[context.develop]

scripts/checklinks-internal.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ const checkForDeadLocalUrls = async () => {
6767
// For ease of checking, replace the localhost domain with the live domain, add those to a new array.
6868
let broke = []
6969
deadUrls.forEach(url => {
70-
link = url.replace('http://localhost:3000', 'https://segment.com/docs')
70+
link = url.replace('http://localhost:3000', 'https://engage-ga--segment-docs-private.netlify.app/docs')
7171
if (!link.endsWith('/')){
7272
link = link+'/'
7373
}
@@ -79,7 +79,7 @@ const checkForDeadLocalUrls = async () => {
7979
// For those, we want to remove them from the list of dead links, because they aren't dead.
8080

8181
// app-nginx redirects
82-
const redirects = ['https://segment.com/docs/guides/usage-and-billing/','https://segment.com/docs/connections/sources/catalog/libraries/website/plugins/', 'https://segment.com/docs/assets/docs.bundle.js/']
82+
const redirects = ['https://engage-ga--segment-docs-private.netlify.app/docs/guides/usage-and-billing/','https://engage-ga--segment-docs-private.netlify.app/docs/connections/sources/catalog/libraries/website/plugins/', 'https://engage-ga--segment-docs-private.netlify.app/docs/assets/docs.bundle.js/']
8383

8484
// Redirects generated by Jekyll
8585
// Pull the redirects json file
@@ -89,7 +89,7 @@ const checkForDeadLocalUrls = async () => {
8989
if (!key.endsWith('/')){
9090
key = key+'/'
9191
}
92-
redirects.push('https://segment.com/docs'+key.replace('/docs',''))
92+
redirects.push('https://engage-ga--segment-docs-private.netlify.app/docs'+key.replace('/docs',''))
9393
})
9494
// Remove the redirect urls from the list of broken URLs
9595
broke = broke.filter(val => !redirects.includes(val));

src/_data/glossary.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Analytics.js: |
22
The Segment Javascript library wrapper, which makes it simple to send your data to any tool without having to learn, test or implement the new API for each tool every time.
33
44
API: |
5-
Application Programming Interface. In software, this term describes a way of interacting with software in an automated fashion, without the use of a user-interface designed for humans. In Segment, we call the standard calls (`track`, `page` and `screen`, `identify` and `group`) our API. We also provide the [Public API](/docs/api/), which you can use to configure sources and destinations, and perform other functions in your workspace, without logging in using a web browser.
5+
Application Programming Interface. In software, this term describes a way of interacting with software in an automated fashion, without the use of a user-interface designed for humans. In Segment, we call the standard calls (`track`, `page` and `screen`, `identify` and `group`) our API. We also provide the [Public API](/docs/api/public-api), which you can use to configure sources and destinations, and perform other functions in your workspace, without logging in using a web browser.
66
77
App: |
88
The app is what we call the main Segment web application, the part you log in to, and where you configure sources and destinations, see events in the debugger, manage your tracking plan, and so on.
@@ -42,7 +42,7 @@ Computed trait: |
4242
[Computed traits](/docs/personas/computed-traits/) are per-user, or per-account [traits](#traits) that you create or “compute” in [Personas](/docs/personas/). When you build a Computed Trait, Personas adds it to relevant user profiles.
4343
4444
Custom trait: |
45-
[Custom Traits](/docs/personas/audiences/#custom-traits) are user or account properties collected from all the events you send to Personas. For example, you can add any properties that you send as a part of your track calls or identify calls (`email`, `first_name`, `last_name`) as custom traits. You can then view them in the profile explorer, and use them in your audiences, computed traits and SQL traits.
45+
[Custom Traits](/docs/engage/audiences/#custom-traits) are user or account properties collected from all the events you send to Personas. For example, you can add any properties that you send as a part of your track calls or identify calls (`email`, `first_name`, `last_name`) as custom traits. You can then view them in the profile explorer, and use them in your audiences, computed traits and SQL traits.
4646
4747
Debugger: |
4848
This is the place in the app where you can see your events flowing through Segment

src/_data/landing.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ sections:
1717
icon: protocols.svg
1818
description: "Prevent data quality issues with a tracking schema and enforcement with Protocols."
1919
path: /protocols/
20-
- name: Personalize interactions
21-
icon: personas.svg
22-
description: "Improve customer interactions by building audiences that power personalized experiences."
23-
path: /personas/
20+
- name: Personalize experiences
21+
icon: engage.svg
22+
description: "Build audiences and journeys from real-time customer data to personalize experiences on every channel."
23+
path: /engage/
2424
- name: Respect users' privacy
2525
icon: privacy.svg
2626
description: "Keep customer data private with Segment's data discovery and policy enforcement tools."

src/_data/products.yml

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,50 @@
11
items:
2-
- product_display_name: Personas
3-
slug: personas
4-
plan-note: "Personas is available as an add-on for Business plans only."
2+
- product_display_name: Engage Foundations
3+
slug: engage-foundations
4+
plan-note: "Engage Foundations requires a Business tier account and includes Profiles."
5+
addon: true
56
plans:
67
free: false
78
team: false
89
business: true
9-
add-on: true
10-
- product_display_name: Personas Identity Graph
11-
slug: personas-id
10+
# addons:
11+
# profiles: true
12+
# engage-foundations: true
13+
# engage-plus: false
14+
- product_display_name: Engage Premier
15+
slug: engage-premier
16+
plan-note: "Engage Premier requires a Business tier account and includes Engage Foundations and Profiles."
17+
addon: true
1218
plans:
1319
free: false
1420
team: false
1521
business: true
16-
add-on: true
22+
# addons:
23+
# profiles: false
24+
# engage-foundations: false
25+
# engage-plus: true
26+
27+
- product_display_name: Profiles
28+
slug: profiles
29+
plan-note: "Profiles requires a Business tier account and is included with Engage."
30+
addon: true
31+
plans:
32+
free: false
33+
team: false
34+
business: true
35+
# addons:
36+
# profiles: true
37+
# engage-foundations: false
38+
# engage-plus: false
39+
1740
- product_display_name: Protocols
1841
slug: protocols
1942
plan-note: "Protocols is available as an add-on for Business plans only."
43+
addon: true
2044
plans:
2145
free: false
2246
team: false
2347
business: true
24-
add-on: true
2548
- product_display_name: Advanced Access Management
2649
slug: iam
2750
plan-note: "Advanced Access Management is available for all Business plans."

src/_data/sidenav/engage.yml

Lines changed: 0 additions & 115 deletions
This file was deleted.

0 commit comments

Comments
 (0)