Skip to content

Commit 0422373

Browse files
author
markzegarelli
authored
Merge branch 'master' into DOC-146_Data-Res-Updates
2 parents b68bb84 + f645eac commit 0422373

File tree

15 files changed

+163
-60
lines changed

15 files changed

+163
-60
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,9 +189,9 @@ Each piece of frontmatter does something special!
189189
#### Content-related frontmatter
190190
- `beta`: default false. When true, show an "in beta" warning in the page layout (see the warning in `_includes/content/beta-note.md`)
191191
- `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.
192-
- `hide-boilerplate`: defaults to false. When true, none of the content from `integration-foot.md` is appended to the destination page.
192+
- `hide-boilerplate`: defaults to false. When true, none of the content from `destination-footer.md` is appended to the destination page.
193193
- `hide-cmodes`: defaults to false. A renaming of "rewrite" for more clarity, hides the connection modes table in the boilerplate.
194-
- `hide-personas-partial`: defaults to false. When true, hides the section of content from `integration-foot.md` that talks about being able to receive personas data.
194+
- `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.
195195
- `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.
196196
- `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.
197197

_config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ defaults:
2525
path: "connections/destinations/catalog"
2626
values:
2727
integration_type: destination
28-
layout: integration
28+
layout: destination
2929
- scope:
3030
path: "connections/sources/catalog"
3131
values:
3232
integration_type: source
33-
layout: integration
33+
layout: source
3434
- scope:
3535
path: "connections/storage/catalog"
3636
values:
@@ -53,4 +53,4 @@ algolia:
5353
application_id: UINQ2M4D9S
5454
index_name: segment-docs
5555
files_to_exclude:
56-
- _release_notes/*
56+
- _release_notes/*

devguide.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,19 @@ It also does some slugification and destination-name normalization, since our ha
5353

5454
### Layouts
5555

56-
`default.html` is the base container through which all the individual other layouts (currently one, `page.html`) are built to have the right title, seo, etc. `Integration.html` contains the logic that runs the catalog pages.
56+
`default.html` is the base container through which all the individual other layouts are built to have the right title, seo, etc. The template inheritance is described in the diagram below.
57+
58+
The `destination.html`, `source.html`, and `integration.html` templates contain the logic that runs the layouts for individual catalog pages. Storage/warehouses use the generic Integration right now because they don't need anything special. Set the layout in the Jekyll `_config.yml` file.
5759

5860
```text
5961
default.html
60-
|- integration.html
61-
|- catalog.html
62-
|- main.html
63-
|-page.html
64-
|-home.html
62+
|- integration.html
63+
|- destination.html
64+
|- source.html
65+
|- main.html
66+
|- catalog.html
67+
|- home.html
68+
|- page.html
6569
```
6670

6771
### Platform Config API + Catalog

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 PLATFORM API. DO NOT EDIT
2-
# destination categories last updated 2021-03-10
2+
# destination categories last updated 2021-03-29
33
items:
44
- display_name: Email Marketing
55
slug: email-marketing

src/_data/catalog/destinations.yml

Lines changed: 74 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# destination data last updated 2021-03-10
2+
# destination data last updated 2021-03-29
33
items:
44
- display_name: ActiveCampaign
55
slug: activecampaign
@@ -13672,6 +13672,26 @@ items:
1367213672
required: false
1367313673
description: Map your Segment properties to the Marketo Activity Fields
1367413674
settings:
13675+
- name: marketoAttributeType
13676+
display_name: Marketo Field Type
13677+
type: SELECT
13678+
deprecated: false
13679+
required: true
13680+
select_validators:
13681+
select_options:
13682+
- string
13683+
- boolean
13684+
- number
13685+
- date
13686+
description: Enter the Marketo Field type.
13687+
settings: []
13688+
- name: primaryKey
13689+
display_name: Set as Primary Key
13690+
type: BOOLEAN
13691+
deprecated: false
13692+
required: false
13693+
description: Mark this property as the Primary field in Marketo.
13694+
settings: []
1367513695
- name: segmentProperty
1367613696
display_name: Segment Property Name
1367713697
type: STRING
@@ -13694,26 +13714,6 @@ items:
1369413714
Enter the Marketo Field name. Make sure to copy and paste the exact
1369513715
API Name for your field as it appears in Marketo.
1369613716
settings: []
13697-
- name: marketoAttributeType
13698-
display_name: Marketo Field Type
13699-
type: SELECT
13700-
deprecated: false
13701-
required: true
13702-
select_validators:
13703-
select_options:
13704-
- string
13705-
- boolean
13706-
- number
13707-
- date
13708-
description: Enter the Marketo Field type.
13709-
settings: []
13710-
- name: primaryKey
13711-
display_name: Set as Primary Key
13712-
type: BOOLEAN
13713-
deprecated: false
13714-
required: false
13715-
description: Mark this property as the Primary field in Marketo.
13716-
settings: []
1371713717
- name: event
1371813718
display_name: Segment Event Name
1371913719
type: STRING
@@ -16689,6 +16689,59 @@ items:
1668916689
server: false
1669016690
previous_names:
1669116691
- Pingdom
16692+
- display_name: Pinterest Audiences
16693+
slug: pinterest-audiences
16694+
name: catalog/destinations/pinterest-audiences
16695+
description: >-
16696+
The Pinterest Audiences integration lets you add user audiences for
16697+
remarketing.
16698+
hidden: false
16699+
url: connections/destinations/catalog/pinterest-audiences
16700+
status: PUBLIC
16701+
logo:
16702+
url: 'https://cdn.filepicker.io/api/file/p3vCawmQ2CtnbacRnRHD'
16703+
mark:
16704+
url: 'https://cdn.filepicker.io/api/file/GBX5NV3USYmSOcpePkA1'
16705+
categories:
16706+
- Advertising
16707+
components:
16708+
- type: CLOUD
16709+
platforms:
16710+
browser: false
16711+
server: true
16712+
mobile: false
16713+
browserUnbundlingSupported: false
16714+
browserUnbundlingPublic: true
16715+
methods:
16716+
alias: false
16717+
group: false
16718+
identify: false
16719+
page_view: false
16720+
track: true
16721+
settings:
16722+
- name: account
16723+
display_name: account
16724+
type: STRING
16725+
deprecated: false
16726+
required: true
16727+
string_validators:
16728+
regexp: ^\d+$
16729+
description: >-
16730+
You can find your Account ID on the **Account Settings** page of your
16731+
[Pinterest Ads account](https://ads.pinterest.com/). It should be a series
16732+
of numbers, like `319762813599`.
16733+
settings: []
16734+
connection_modes:
16735+
device:
16736+
web: false
16737+
mobile: false
16738+
server: false
16739+
cloud:
16740+
web: false
16741+
mobile: true
16742+
server: true
16743+
previous_names:
16744+
- Pinterest Audiences
1669216745
- display_name: Pinterest Tag
1669316746
slug: pinterest-tag
1669416747
name: catalog/destinations/pinterest-tag

src/_data/catalog/source_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# source cateogries last updated 2021-03-10
2+
# source cateogries last updated 2021-03-29
33
items:
44
- display_name: Server
55
slug: server

src/_data/catalog/sources.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# sources last updated 2021-03-10
2+
# sources last updated 2021-03-29
33
items:
44
- display_name: .NET
55
slug: net
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- canary comment -->
2+
3+
<!-- in the file we're pulling from the API, "name" corresponds with the path to the yml blob for a specific destination.-->
4+
{% assign currentSlug = page.url | split: "/" | last %}
5+
{% assign currentIntegration = site.data.catalog.destinations.items | where: "slug", currentSlug | first %}
6+
{% if currentIntegration %}
7+
<!-- this endif prevents you from showing a dossier if there's no info in destinations.yml-->
8+
9+
10+
11+
<!-- TODO -->
12+
13+
14+
{% endif %}
File renamed without changes.

src/_layouts/destination.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: integration
3+
---
4+
<div class="markdown">
5+
6+
{% unless page.hide-dossier == true %}
7+
{% capture destination-dossier %}{% include content/destination-dossier.md %}{% endcapture %}
8+
{{ destination-dossier | markdownify }}
9+
{% endunless %}
10+
11+
12+
{{ content }}
13+
14+
{% unless page.hide-boilerplate == true %}
15+
{% capture destination-footer %}{% include content/destination-footer.md %}{% endcapture %}
16+
{{ destination-footer | markdownify }}
17+
{% endunless %}
18+
19+
</div>

0 commit comments

Comments
 (0)