Skip to content

Commit 818bbc9

Browse files
authored
Merge pull request #3 from segmentio/develop
sync fork
2 parents f6f522f + abf12aa commit 818bbc9

File tree

1,425 files changed

+138690
-59966
lines changed

Some content is hidden

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

1,425 files changed

+138690
-59966
lines changed

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ CONTEXT=development
66
PLATFORM_API_TOKEN=generate a token from your Segment workspace
77
PAPI_TOKEN=generate a token from your Segment workspace
88
ALGOLIA_APP_ID=
9-
ALGOLIA_SEARCH_KEY=
9+
ALGOLIA_SEARCH_KEY=

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Aampe
2222
adset
2323
Adwords
2424
Aircall
25+
Airdat(?:e|es)
2526
Algolia
2627
allowlist
2728
Amberflo
@@ -33,22 +34,28 @@ Automations
3334
aws
3435
background(?:ed|ing)
3536
Bento
37+
Bing
38+
Blackbaud
3639
Blitzllama
3740
blocklist
3841
Bluedot
3942
bool
4043
boolean
44+
Braze's
4145
Breyta
4246
Chargebee
4347
chatbot
4448
cli
4549
CloudFront
4650
Cocoapods
51+
comScore
4752
Contentful
53+
Cordova
4854
Criteo
4955
csv
5056
Databricks
5157
datetime
58+
debouncing
5259
deeplink
5360
Dev
5461
Doubleclick
@@ -99,6 +106,7 @@ Marketo
99106
Matcha
100107
matchers
101108
measurability
109+
Metrix
102110
middleware
103111
Middleware
104112
Mixpanel
@@ -122,6 +130,7 @@ performant
122130
Pinterest
123131
Pipedrive
124132
Preact
133+
Proguard
125134
Qualtrics
126135
reformat(:?s)
127136
remarket

.tool-versions

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ruby 2.7.8
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

CODEOWNERS

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -21,55 +21,33 @@ CODEOWNERS @segmentio/segment-doc-team
2121

2222

2323
# Libraries owners
24-
/src/connections/catalog/libraries @stayseesong @markzegarelli
24+
/src/connections/catalog/libraries @stayseesong
2525

2626

2727
# Destinations owners
28-
/src/connections/destinations @stayseesong @markzegarelli
28+
# /src/connections/destinations @stayseesong=
2929

3030
# Stratconn
3131
## Adobe
32-
/src/connections/destinations/catalog/adobe-analytics/ @kdaswani
33-
/src/connections/destinations/catalog/actions-adobe-target-web/ @kdaswani
34-
/src/connections/destinations/catalog/actions-adobe-target-cloud/ @kdaswani
35-
/src/connections/destinations/catalog/marketo-v2/ @kdaswani
36-
/src/connections/destinations/catalog/marketo-static-lists/ @kdaswani
32+
3733

3834
## Facebook
39-
/src/connections/destinations/catalog/facebook-pixel/ @kdaswani
40-
/src/connections/destinations/catalog/actions-facebook-conversions-api/ @kdaswani
41-
/src/connections/destinations/catalog/facebook-app-events/ @kdaswani
42-
/src/connections/destinations/catalog/facebook-offline-conversions/ @kdaswani
43-
/src/connections/destinations/catalog/personas-facebook-custom-audiences/ @kdaswani
35+
4436

4537
## Google
46-
/src/connections/destinations/catalog/firebase/ @kdaswani
47-
/src/connections/destinations/catalog/google-analytics/ @kdaswani
48-
/src/connections/destinations/catalog/actions-google-analytics-4/ @kdaswani
49-
/src/connections/destinations/catalog/google-tag-manager/ @kdaswani
50-
/src/connections/destinations/catalog/actions-google-enhanced-conversions/ @kdaswani
51-
/src/connections/destinations/catalog/doubleclick-floodlight/ @kdaswani
52-
/src/connections/destinations/catalog/google-ads-classic/ @kdaswani
53-
/src/connections/destinations/catalog/google-ads-gtag/ @kdaswani
54-
/src/connections/destinations/catalog/google-cloud-function/ @kdaswani
55-
/src/connections/destinations/catalog/google-cloud-pubsub/ @kdaswani
56-
/src/connections/destinations/catalog/adwords-remarketing-lists/ @kdaswani
57-
/src/connections/destinations/catalog/personas-display-video-360/ @kdaswani
38+
5839

5940
## Salesforce
60-
/src/connections/destinations/catalog/salesforce/ @kdaswani
61-
/src/connections/destinations/catalog/actions-salesforce/ @kdaswani
62-
/src/connections/destinations/catalog/salesforce-marketing-cloud/ @kdaswani
63-
/src/connections/destinations/catalog/pardot/ @kdaswani
41+
6442

6543
# Engage
66-
/src/engage/ @markzegarelli @pwseg @rchinn-segment
44+
/src/engage/ @pwseg
6745

68-
# Personas owners
69-
/src/personas @pwseg @rchinn-segent
46+
# Unify
47+
/src/unify @pwseg
7048

7149
# Protocols owners
7250
/src/protocols @forstisabella
7351

7452
# Storage owners
75-
/src/connections/storage @forstisabella
53+
/src/connections/storage @forstisabella

CONTRIBUTING.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The most interesting ones are:
4141

4242
**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

44-
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.
44+
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 downloaded by a script to migrate it out of Contents.io.
4545

4646
In general, it's a good practice to name images with a description that helps you (& other docs maintainers) figure out where they should go within a page, or within a larger folder of images.
4747

@@ -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.
@@ -101,7 +111,7 @@ Front matter variables have unique functions, including the following:
101111
- `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.
102112
- `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.
103113
- `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.
104-
114+
- `private`: Used to indicate that a destination is not publicly available (Private Beta or Pilot status), and is not available in the public catalog. When `private: true`, the build pulls integration metadata from `src/_data/catalog/destinations_private.yml`. To update the list of private destinations, use the `make private_destination` command, and enter the integration's ID when prompted.
105115
#### Utility front matter
106116
- `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.
107117
- `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.
@@ -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/)."

Gemfile.lock

Lines changed: 38 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
GIT
22
remote: https://github.com/jekyll/jekyll.git
3-
revision: 26a949df85a1f9577e8080e19f2196c8a3db17ec
3+
revision: 58a1f62b2349bb477fc9999c40331cecdca577d8
44
specs:
5-
jekyll (4.2.1)
5+
jekyll (4.3.2)
66
addressable (~> 2.4)
77
colorator (~> 1.0)
88
em-websocket (~> 0.5)
99
i18n (~> 1.0)
10-
jekyll-sass-converter (~> 2.0)
10+
jekyll-sass-converter (>= 2.0, < 4.0)
1111
jekyll-watch (~> 2.0)
1212
kramdown (~> 2.3, >= 2.3.1)
1313
kramdown-parser-gfm (~> 1.0)
1414
liquid (~> 4.0)
1515
mercenary (>= 0.3.6, < 0.5)
1616
pathutil (~> 0.9)
17-
rouge (~> 3.0)
17+
rouge (>= 3.0, < 5.0)
1818
safe_yaml (~> 1.0)
1919
terminal-table (>= 1.8, < 4.0)
2020
webrick (~> 1.7)
2121

2222
GEM
2323
remote: https://rubygems.org/
2424
specs:
25-
addressable (2.8.0)
26-
public_suffix (>= 2.0.2, < 5.0)
25+
addressable (2.8.4)
26+
public_suffix (>= 2.0.2, < 6.0)
2727
algolia_html_extractor (2.6.4)
2828
json (~> 2.0)
2929
nokogiri (~> 1.10)
@@ -32,37 +32,23 @@ GEM
3232
json (>= 1.5.1)
3333
colorator (1.1.0)
3434
commonmarker (0.23.9)
35-
concurrent-ruby (1.1.9)
36-
dotenv (2.7.6)
37-
em-websocket (0.5.2)
35+
concurrent-ruby (1.2.2)
36+
dotenv (2.8.1)
37+
em-websocket (0.5.3)
3838
eventmachine (>= 0.12.9)
39-
http_parser.rb (~> 0.6.0)
39+
http_parser.rb (~> 0)
4040
eventmachine (1.2.7)
41-
faraday (1.8.0)
42-
faraday-em_http (~> 1.0)
43-
faraday-em_synchrony (~> 1.0)
44-
faraday-excon (~> 1.1)
45-
faraday-httpclient (~> 1.0.1)
46-
faraday-net_http (~> 1.0)
47-
faraday-net_http_persistent (~> 1.1)
48-
faraday-patron (~> 1.0)
49-
faraday-rack (~> 1.0)
50-
multipart-post (>= 1.2, < 3)
41+
faraday (2.7.5)
42+
faraday-net_http (>= 2.0, < 3.1)
5143
ruby2_keywords (>= 0.0.4)
52-
faraday-em_http (1.0.0)
53-
faraday-em_synchrony (1.0.0)
54-
faraday-excon (1.1.0)
55-
faraday-httpclient (1.0.1)
56-
faraday-net_http (1.0.1)
57-
faraday-net_http_persistent (1.2.0)
58-
faraday-patron (1.0.0)
59-
faraday-rack (1.0.0)
60-
ffi (1.15.4)
44+
faraday-net_http (3.0.2)
45+
ffi (1.15.5)
6146
filesize (0.2.0)
6247
forwardable-extended (2.6.0)
63-
http_parser.rb (0.6.0)
48+
google-protobuf (3.23.2-x86_64-darwin)
49+
http_parser.rb (0.8.0)
6450
httpclient (2.8.3)
65-
i18n (1.8.10)
51+
i18n (1.13.0)
6652
concurrent-ruby (~> 1.0)
6753
jekyll-algolia (1.7.1)
6854
algolia_html_extractor (~> 2.6)
@@ -73,9 +59,8 @@ GEM
7359
nokogiri (~> 1.6)
7460
progressbar (~> 1.9)
7561
verbal_expressions (~> 0.1.5)
76-
jekyll-commonmark (1.3.1)
77-
commonmarker (~> 0.14)
78-
jekyll (>= 3.7, < 5.0)
62+
jekyll-commonmark (1.4.0)
63+
commonmarker (~> 0.22)
7964
jekyll-dotenv (0.2.0)
8065
dotenv (~> 2.7)
8166
jekyll (~> 4)
@@ -86,67 +71,57 @@ GEM
8671
posix-spawn (~> 0.3.9)
8772
jekyll-redirect-from (0.16.0)
8873
jekyll (>= 3.3, < 5.0)
89-
jekyll-sass-converter (2.1.0)
90-
sassc (> 2.0.1, < 3.0)
74+
jekyll-sass-converter (3.0.0)
75+
sass-embedded (~> 1.54)
9176
jekyll-sitemap (1.4.0)
9277
jekyll (>= 3.7, < 5.0)
9378
jekyll-watch (2.2.1)
9479
listen (~> 3.0)
95-
json (2.6.0)
96-
kramdown (2.3.1)
80+
json (2.6.3)
81+
kramdown (2.4.0)
9782
rexml
9883
kramdown-parser-gfm (1.1.0)
9984
kramdown (~> 2.0)
100-
liquid (4.0.3)
101-
listen (3.7.0)
85+
liquid (4.0.4)
86+
listen (3.8.0)
10287
rb-fsevent (~> 0.10, >= 0.10.3)
10388
rb-inotify (~> 0.9, >= 0.9.10)
10489
mercenary (0.4.0)
105-
mini_portile2 (2.8.1)
106-
multipart-post (2.1.1)
107-
nokogiri (1.14.3)
108-
mini_portile2 (~> 2.8.0)
109-
racc (~> 1.4)
110-
nokogiri (1.14.3-arm64-darwin)
111-
racc (~> 1.4)
112-
nokogiri (1.14.3-x86_64-darwin)
113-
racc (~> 1.4)
114-
nokogiri (1.14.3-x86_64-linux)
90+
nokogiri (1.15.2-x86_64-darwin)
11591
racc (~> 1.4)
11692
pathutil (0.16.2)
11793
forwardable-extended (~> 2.6)
11894
posix-spawn (0.3.15)
11995
premonition (2.0.1)
120-
progressbar (1.11.0)
121-
public_suffix (4.0.6)
96+
progressbar (1.13.0)
97+
public_suffix (5.0.1)
12298
racc (1.6.2)
12399
rake (13.0.6)
124-
rb-fsevent (0.11.0)
100+
rb-fsevent (0.11.2)
125101
rb-inotify (0.10.1)
126102
ffi (~> 1.0)
127103
rexml (3.2.5)
128-
rouge (3.26.1)
104+
rouge (4.1.2)
129105
ruby2_keywords (0.0.5)
130106
safe_yaml (1.0.5)
131-
sassc (2.4.0)
132-
ffi (~> 1.9)
107+
sass-embedded (1.62.1-x86_64-darwin)
108+
google-protobuf (~> 3.21)
133109
terminal-table (3.0.2)
134110
unicode-display_width (>= 1.1.1, < 3)
135111
thread_safe (0.3.6)
136-
tzinfo (1.2.10)
112+
tzinfo (1.2.11)
137113
thread_safe (~> 0.1)
138-
tzinfo-data (1.2021.4)
114+
tzinfo-data (1.2023.3)
139115
tzinfo (>= 1.0.0)
140-
unicode-display_width (2.1.0)
116+
unicode-display_width (2.4.2)
141117
verbal_expressions (0.1.5)
142118
wdm (0.1.1)
143-
webrick (1.7.0)
119+
webrick (1.8.1)
144120

145121
PLATFORMS
146-
arm64-darwin-20
147122
ruby
123+
x86_64-darwin-19
148124
x86_64-darwin-20
149-
x86_64-linux
150125

151126
DEPENDENCIES
152127
dotenv
@@ -166,4 +141,4 @@ DEPENDENCIES
166141
wdm (~> 0.1.0)
167142

168143
BUNDLED WITH
169-
2.2.2
144+
2.2.18

0 commit comments

Comments
 (0)