Skip to content

repo sync #3564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions .github/styles/Vocab/Docs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
(?:R|r)emarketing
(?:U|u)nlinks?\b
(?:U|u)nmaps?\b
(?:U|u)ploader
(?:U|u)rls?\b
adset
Adwords
Expand Down Expand Up @@ -42,6 +43,7 @@ datetime
deeplink
Dev
Doubleclick
enablement
endcapture
endfor
endif
Expand Down Expand Up @@ -81,6 +83,7 @@ Mailmodo
markdownify
Marketo
Matcha
matchers
measurability
middleware
Middleware
Expand All @@ -94,8 +97,10 @@ Optimizely
param(:?s)
Pardot
performant
Pinterest
Preact
Qualtrics
Responsys
Rokt
Selligent
Sendgrid
Expand Down
87 changes: 0 additions & 87 deletions js/algolia/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ const algoliaInsightsPlugin = createAlgoliaInsightsPlugin({ insightsClient });

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

function initAutocomplete(item){
const search = autocomplete({
Expand Down Expand Up @@ -106,90 +105,4 @@ function initAutocomplete(item){

}

function initEngageAutocomplete(item){
const search = autocomplete({
container: item,
placeholder: "Search the Twilio Engage documentation",
debug: false,
openOnFocus: false,
keyboardShortcuts: ['s', 191],
plugins: [algoliaInsightsPlugin,],
detachedMediaQuery:'none',
getSources( {query} ) {
return [
{
sourceId: 'articles',
getItemUrl({ item }){
if (item.anchor != null) {
var itemUrl = '/docs'+item.url+"#" + item.anchor;
} else {
var itemUrl = '/docs'+item.url;
}
return itemUrl;
},
getItems() {
return getAlgoliaResults({
searchClient,
queries: [
{
indexName: 'segment-docs',
query,
params: {
hitsPerPage: 7,
facetFilters: ['hidden:-true'],
clickAnalytics: true,
},
},
],
});
},
templates: {
item({ item, createElement }){
if (item.anchor != null) {
var anchorLink = "#" + item.anchor;
} else {
var anchorLink = "";
}

if (item.engage){
var engage = "<span class='engage-pill'>Engage</span>"
}
return createElement('div',{
dangerouslySetInnerHTML: {
__html: `<a class="aa-link" href="/docs${item.url}${anchorLink}">
<p class="aa-title" >${highlightHit({hit: item, attribute: 'title'})} ${engage}</h3>
<p class="aa-content">${highlightHit({hit: item, attribute: 'content'})}</p></a>`
}
})
},
noResults() {
return html `<p class="aa-content">No results for <strong>${query}</strong></p>`;
}
},

},
];
},
navigator: {
navigate({ itemUrl }) {
window.location.assign(itemUrl);
},
navigateNewTab({ itemUrl }) {
const windowReference = window.open(itemUrl, '_blank', 'noopener');

if (windowReference) {
windowReference.focus();
}
},
navigateNewWindow({ itemUrl }) {
window.open(itemUrl, '_blank', 'noopener');
},
},
});

}
if (loc.startsWith("/docs/engage")) {
engage_locations.forEach(initEngageAutocomplete)
} else {
locations.forEach(initAutocomplete);
}
2 changes: 1 addition & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
ignore = "./scripts/ignore.sh"

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

[context.develop]
Expand Down
6 changes: 3 additions & 3 deletions scripts/checklinks-internal.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ const checkForDeadLocalUrls = async () => {
// For ease of checking, replace the localhost domain with the live domain, add those to a new array.
let broke = []
deadUrls.forEach(url => {
link = url.replace('http://localhost:3000', 'https://segment.com/docs')
link = url.replace('http://localhost:3000', 'https://engage-ga--segment-docs-private.netlify.app/docs')
if (!link.endsWith('/')){
link = link+'/'
}
Expand All @@ -79,7 +79,7 @@ const checkForDeadLocalUrls = async () => {
// For those, we want to remove them from the list of dead links, because they aren't dead.

// app-nginx redirects
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/']
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/']

// Redirects generated by Jekyll
// Pull the redirects json file
Expand All @@ -89,7 +89,7 @@ const checkForDeadLocalUrls = async () => {
if (!key.endsWith('/')){
key = key+'/'
}
redirects.push('https://segment.com/docs'+key.replace('/docs',''))
redirects.push('https://engage-ga--segment-docs-private.netlify.app/docs'+key.replace('/docs',''))
})
// Remove the redirect urls from the list of broken URLs
broke = broke.filter(val => !redirects.includes(val));
Expand Down
4 changes: 2 additions & 2 deletions src/_data/glossary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Analytics.js: |
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.

API: |
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.
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.

App: |
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.
Expand Down Expand Up @@ -42,7 +42,7 @@ Computed trait: |
[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.

Custom trait: |
[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.
[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.

Debugger: |
This is the place in the app where you can see your events flowing through Segment
Expand Down
8 changes: 4 additions & 4 deletions src/_data/landing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ sections:
icon: protocols.svg
description: "Prevent data quality issues with a tracking schema and enforcement with Protocols."
path: /protocols/
- name: Personalize interactions
icon: personas.svg
description: "Improve customer interactions by building audiences that power personalized experiences."
path: /personas/
- name: Personalize experiences
icon: engage.svg
description: "Build audiences and journeys from real-time customer data to personalize experiences on every channel."
path: /engage/
- name: Respect users' privacy
icon: privacy.svg
description: "Keep customer data private with Segment's data discovery and policy enforcement tools."
Expand Down
39 changes: 31 additions & 8 deletions src/_data/products.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,50 @@
items:
- product_display_name: Personas
slug: personas
plan-note: "Personas is available as an add-on for Business plans only."
- product_display_name: Engage Foundations
slug: engage-foundations
plan-note: "Engage Foundations requires a Business tier account and includes Profiles."
addon: true
plans:
free: false
team: false
business: true
add-on: true
- product_display_name: Personas Identity Graph
slug: personas-id
# addons:
# profiles: true
# engage-foundations: true
# engage-plus: false
- product_display_name: Engage Premier
slug: engage-premier
plan-note: "Engage Premier requires a Business tier account and includes Engage Foundations and Profiles."
addon: true
plans:
free: false
team: false
business: true
add-on: true
# addons:
# profiles: false
# engage-foundations: false
# engage-plus: true

- product_display_name: Profiles
slug: profiles
plan-note: "Profiles requires a Business tier account and is included with Engage."
addon: true
plans:
free: false
team: false
business: true
# addons:
# profiles: true
# engage-foundations: false
# engage-plus: false

- product_display_name: Protocols
slug: protocols
plan-note: "Protocols is available as an add-on for Business plans only."
addon: true
plans:
free: false
team: false
business: true
add-on: true
- product_display_name: Advanced Access Management
slug: iam
plan-note: "Advanced Access Management is available for all Business plans."
Expand Down
115 changes: 0 additions & 115 deletions src/_data/sidenav/engage.yml

This file was deleted.

Loading