Skip to content

Commit 275b09f

Browse files
markzegarelliforstisabellapwsegbot-docsteamkdaswani
authored
Release 22.5.1 (#2443)
* Adding admonition infrastructure * DOC-393 Taking it out of an admonition format and adding it to the paragraph above it * [DOC-393] Simplifying the information, adding it to the sentence before it * Fixes to Contributing page * small update to ga4 * Update CONTRIBUTING.md Frontmatter -> Front matter * Add note about Criteo connection modes with Analytics.js (#2437) * Add clarity to HubSpot API limit (#2436) * Update CONTRIBUTING.md * catalog update * Add Troubleshooting section to GEC docs (#2434) * add Troubleshooting section to GEC docs * style edits Co-authored-by: markzegarelli <mark.zegarelli@segment.com> * redirect sprig actions (#2423) * remove connection table * Linking to FQL from Destination Filters doc (#2421) * Linking to FQL from Destination Filters doc * Update src/connections/destinations/destination-filters.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> * [byteplus] adding new destination folder in order to show new name in… (#2414) * [byteplus] adding new destination folder in order to show new name in docs URL * local links should be relative Co-authored-by: markzegarelli <mark.zegarelli@segment.com> * Add region unsupported message for all cloud sources (#2422) * Add region unsupported message for all cloud sources * Remove spaces * prettify markdown * copy edits Co-authored-by: markzegarelli <mark.zegarelli@segment.com> Co-authored-by: forstisabella <92472883+forstisabella@users.noreply.github.com> Co-authored-by: pwseg <paul.wooley@segment.com> Co-authored-by: Segment Docs Robot <73141528+bot-docsteam@users.noreply.github.com> Co-authored-by: kdaswani <49517136+kdaswani@users.noreply.github.com> Co-authored-by: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com> Co-authored-by: Niall Brennan <niall.brennan@segment.com> Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> Co-authored-by: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> Co-authored-by: jinapark202 <87985289+jinapark202@users.noreply.github.com>
1 parent bd21e9d commit 275b09f

File tree

76 files changed

+517
-241
lines changed

Some content is hidden

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

76 files changed

+517
-241
lines changed

‎.vscode/yml.code-snippets‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,4 @@
2121
"body":["- name: ${1:name}\r\tdescription: ${2:description}\r\tdefault: ${3}"],
2222
"description": "Yaml settings"
2323
},
24-
"ext_link":{
25-
"prefix": ["{:}"],
26-
"body":["{:target='${1:_blank}'}"]
27-
},
2824
}

‎CONTRIBUTING.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Before you begin:
1010

1111
## Use the contribution links from any docs page
1212

13-
Not all pages have a 1-1 mapping with their location within the repository. This can make browsing and locating the file you're trying to reference a challenge. As you browse [segment.com/docs](https://segment.com/docs), you'll notice two links in the right sidebar, at the top of the page. Click **Edit this page** to open the page in the Github editor. Or, click **Request docs change** to create a new issue that references the page.
13+
Not all pages have a 1-1 mapping with their location within the repository. This can make browsing and locating the file you're trying to reference a challenge. As you browse [segment.com/docs](https://segment.com/docs), you'll notice two links in the right sidebar, at the top of the page. Click **Edit this page** to open the page in the GitHub editor. Or, click **Request docs change** to create a new issue that references the page.
1414

1515
## Want to go deeper? Fork the repository
1616

@@ -39,7 +39,7 @@ The most interesting ones are:
3939

4040
### Images
4141

42-
**Save all images locally! No linking to 3rd party-hosted images!** Images are published to our CDN from the build step, and this means they won't go missing if the hosting service dujour goes out of business.
42+
**Save all images locally! No linking to third-party hosted images!** Images are published to our CDN from the build step, and this means they won't go missing if the hosting service dujour goes out of business.
4343

4444
There are no _enforced_ naming conventions at this time. Files that start with an underscore are ignored by Jekyll. Anything you see with `asset` was dowloaded by a script to migrate it out of Contents.io.
4545

@@ -77,11 +77,11 @@ 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-
### Frontmatter
80+
### Front matter
8181

82-
Each Markdown file in the docs can have "frontmatter" associated with it at the top of the file. These are considered by Jekyll to be "properties" of a page, generally control how the HTML page is built or rendered.
82+
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.
8383

84-
Frontmatter in a file will look something like this:
84+
Front matter in a file will look something like this:
8585

8686
```md
8787
---
@@ -90,25 +90,25 @@ hide-feedback: false
9090
---
9191
```
9292

93-
Each piece of frontmatter does something special!
93+
Front matter variables have unique functions, including the following:
9494

95-
#### Content-related frontmatter
95+
#### Content-related front matter
9696
- `beta`: default false. When true, show an "in beta" warning in the page layout (see the warning in `_includes/content/beta-note.md`)
97-
- `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. It disables the duplicate "connection modes" table that would otherwise show up in the boilerplate content at the end of the page.
97+
- `rewrite`: defaults to false. This is a legacy front matter flag that comes from the old `site-docs` repo, and which labels any destination that was rewritten in ~2018 to a standardized template. It disables the duplicate "connection modes" table that would otherwise show up in the boilerplate content at the end of the page.
9898
- `hide-dossier`: defaults to false. When true, hides the "quick info" box at the top of a destination page.
9999
- `hide-boilerplate`: defaults to false. When true, none of the content from `destination-footer.md` is appended to the destination page.
100100
- `hide-cmodes`: defaults to false. A renaming of "rewrite" for more clarity, hides the connection modes table in the boilerplate.
101101
- `hide-personas-partial`: defaults to false. When true, hides the section of content from `destination-footer.md` that talks about being able to receive personas data.
102102
- `integration_type`: This is set in the `_config.yml` on three paths to add a noun (Source, Destination, or Warehouse) to the end of the title, and the end of the title tag in the html layout. It also controls the layout and icon for some of these.
103103
- `source-type`: These are only used to supplement when a Cloud App in the sources path doesn't appear in the Config API list, and needs its type explicitly set. It runs some logic in the `cloud-app-note.md` to explain which cloud-apps are object vs event sources.
104104

105-
#### Utility frontmatter
105+
#### Utility front matter
106106
- `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.
107107
- `hidden`: omits the file from the `sitemap.xml`, adds a `<meta name="robots" content="noindex" />` to the top of the generated HTML file, and drops it from the convenience script for regenerating the nav.
108108
- `hide-sidebar`: defaults to false. When true, hide the entire right-nav sidebar. Use with `hide-feedback` if you want to disable *all* feedback affordances.
109109
- `hide-feedback`: defaults to false. When true, hide the feedback in both rnav and footer. Good for landing pages.
110110
- `hide_toc`: hides the right-nav TOC that's generated from H2s. Also good for landing pages.
111111
- `landing`: defaults to false. Use this to drop the noun set by `integration_type` from the tab title.
112-
- `redirect_from`: Defaults to null. Takes an array of URLs from the frontmatter 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.
112+
- `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.
113113
- `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.
114114
- `seo-priority`: values from `1.0` to `0.1`, default: `0.5 `. Sets the `Priority` tag in the sitemap

‎scripts/catalog_papi.js‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -289,13 +289,14 @@ const updateSources = async () => {
289289
}, options);
290290
fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/source_categories.yml`), output);
291291

292-
// Create reginal support map
293-
output = "# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL\n"
294-
output += "# Last updated " + todayDate + " \n";
292+
293+
// output = "# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL\n"
294+
// output += "# Last updated " + todayDate + " \n";
295295
output += yaml.dump({
296296
sources: regionalSourcesUpdated
297297
}, options)
298-
fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/regional-supported.yml`), output);
298+
fs.appendFileSync(path.resolve(__dirname, `../src/_data/catalog/regional-supported.yml`), output);
299+
console.log("sources done")
299300
}
300301

301302
const updateDestinations = async () => {
@@ -482,6 +483,7 @@ const updateDestinations = async () => {
482483
noArrayIndent: false
483484
})
484485
fs.appendFileSync(path.resolve(__dirname,`../src/_data/catalog/regional-supported.yml`),output);
486+
console.log("destinations done")
485487
}
486488

487489
const updateWarehouses = async () => {
@@ -545,19 +547,23 @@ const updateWarehouses = async () => {
545547
noArrayIndent: true
546548
};
547549
// output = "# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT\n"
548-
// var todayDate = new Date().toISOString().slice(0, 10);
550+
const todayDate = new Date().toISOString().slice(0, 10);
549551
// output += "# warehouse data last updated " + todayDate + " \n";
550552
// output += yaml.dump({
551553
// items: warehousesUpdated
552554
// }, options);
553555
// fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/warehouse_papi.yml`), output);
554556

555-
output = yaml.dump({
557+
// Create regional support map
558+
output = "# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL\n"
559+
output += "# Last updated " + todayDate + " \n";
560+
output += yaml.dump({
556561
warehouses: warehousesUpdated
557562
}, {
558563
noArrayIndent: false
559564
})
560-
fs.appendFileSync(path.resolve(__dirname,`../src/_data/catalog/regional-supported.yml`),output);
565+
fs.writeFileSync(path.resolve(__dirname,`../src/_data/catalog/regional-supported.yml`),output);
566+
console.log("warehouses done")
561567
}
562568
updateSources()
563569
updateWarehouses()

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

‎src/_data/catalog/destinations.yml‎

Lines changed: 58 additions & 56 deletions
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-01-26
2+
# destination data last updated 2022-02-01
33
items:
44
- destination_id: 60b5d0a01f3726b85dc05aab
55
display_name: 2mee
@@ -28839,6 +28839,63 @@ items:
2883928839
label: API Key
2884028840
actions: []
2884128841
presets: []
28842+
- destination_id: 5f2c35239094d175b6485eb1
28843+
display_name: Sprig Cloud
28844+
name: Sprig Cloud
28845+
slug: sprig-cloud
28846+
hidden: false
28847+
regional:
28848+
- us-west
28849+
url: connections/destinations/catalog/sprig-cloud
28850+
previous_names:
28851+
- UserLeap
28852+
- Sprig
28853+
- Sprig Cloud
28854+
website: https://sprig.com
28855+
status: PUBLIC
28856+
categories:
28857+
- Analytics
28858+
- Customer Success
28859+
- Personalization
28860+
- Surveys
28861+
logo:
28862+
url: >-
28863+
https://public-segment-devcenter-production.s3.amazonaws.com/74f53b6f-bc75-4132-b7de-1170cc57202e.svg
28864+
mark:
28865+
url: >-
28866+
https://public-segment-devcenter-production.s3.amazonaws.com/d761456e-2b15-4401-87da-0c3fde847f5b.svg
28867+
methods:
28868+
track: true
28869+
identify: true
28870+
group: false
28871+
alias: true
28872+
page: true
28873+
platforms:
28874+
browser: true
28875+
mobile: true
28876+
server: true
28877+
components: []
28878+
browserUnbundlingSupported: false
28879+
browserUnbundlingPublic: false
28880+
replay: false
28881+
connection_modes:
28882+
device:
28883+
web: false
28884+
mobile: false
28885+
server: false
28886+
cloud:
28887+
web: false
28888+
mobile: false
28889+
server: false
28890+
settings:
28891+
- name: apiKey
28892+
type: string
28893+
defaultValue: ''
28894+
description: Find your API key here https://app.userleap.com/settings/installation
28895+
required: true
28896+
label: API Key
28897+
actions: []
28898+
presets: []
2884228899
- destination_id: 5fa3ce52d18ccdfb384b13f7
2884328900
display_name: Startdeliver
2884428901
name: Startdeliver
@@ -31372,61 +31429,6 @@ items:
3137231429
label: API Key
3137331430
actions: []
3137431431
presets: []
31375-
- destination_id: 5f2c35239094d175b6485eb1
31376-
display_name: UserLeap
31377-
name: UserLeap
31378-
slug: userleap
31379-
hidden: false
31380-
regional:
31381-
- us-west
31382-
url: connections/destinations/catalog/userleap
31383-
previous_names:
31384-
- UserLeap
31385-
website: https://sprig.com
31386-
status: PUBLIC_BETA
31387-
categories:
31388-
- Analytics
31389-
- Customer Success
31390-
- Personalization
31391-
- Surveys
31392-
logo:
31393-
url: >-
31394-
https://public-segment-devcenter-production.s3.amazonaws.com/74f53b6f-bc75-4132-b7de-1170cc57202e.svg
31395-
mark:
31396-
url: >-
31397-
https://public-segment-devcenter-production.s3.amazonaws.com/d761456e-2b15-4401-87da-0c3fde847f5b.svg
31398-
methods:
31399-
track: true
31400-
identify: true
31401-
group: false
31402-
alias: true
31403-
page: true
31404-
platforms:
31405-
browser: true
31406-
mobile: true
31407-
server: true
31408-
components: []
31409-
browserUnbundlingSupported: false
31410-
browserUnbundlingPublic: false
31411-
replay: false
31412-
connection_modes:
31413-
device:
31414-
web: false
31415-
mobile: false
31416-
server: false
31417-
cloud:
31418-
web: false
31419-
mobile: false
31420-
server: false
31421-
settings:
31422-
- name: apiKey
31423-
type: string
31424-
defaultValue: ''
31425-
description: Find your API key here https://app.userleap.com/settings/installation
31426-
required: true
31427-
label: API Key
31428-
actions: []
31429-
presets: []
3143031432
- destination_id: 5c75396a02254a0001da2a55
3143131433
display_name: Userlist
3143231434
name: Userlist

‎src/_data/catalog/overrides.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
# This file is manually generated. When you add or remove an item, add or remove
22
# it from the `overrides-list.yml` too.
33
items:
4+
- slug: criteo-app-web-events
5+
connection_modes:
6+
connection_modes:
7+
device:
8+
web: true
9+
mobile: false
10+
server: false
11+
cloud:
12+
web: false
13+
mobile: true
14+
server: false
415
- slug: doubleclick-floodlight
516
connection_modes:
617
device:

0 commit comments

Comments
 (0)