Merge branch 'master' into littledata-docs-update

Author: edwardupton

Gemfile.lock

@@ -74,7 +74,7 @@ GEM
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     json (2.5.1)
-    kramdown (2.3.0)
+    kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
@@ -124,7 +124,7 @@ GEM
 
 PLATFORMS
   ruby
-  x86_64-linux-musl
+  x86_64-linux
 
 DEPENDENCIES
   dotenv

README.md

@@ -189,9 +189,9 @@ Each piece of frontmatter does something special!
 #### Content-related frontmatter
 - `beta`: default false. When true, show an "in beta" warning in the page layout (see the warning in `_includes/content/beta-note.md`)
 - `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.
-- `hide-boilerplate`: defaults to false. When true, none of the content from `integration-foot.md` is appended to the destination page.
+- `hide-boilerplate`: defaults to false. When true, none of the content from `destination-footer.md` is appended to the destination page.
 - `hide-cmodes`: defaults to false. A renaming of "rewrite" for more clarity, hides the connection modes table in the boilerplate.
-- `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.
+- `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.
 - `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.
 - `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.
 

_config.yml

@@ -25,12 +25,12 @@ defaults:
       path: "connections/destinations/catalog"
     values:
       integration_type: destination
-      layout: integration
+      layout: destination
   - scope:
       path: "connections/sources/catalog"
     values:
       integration_type: source
-      layout: integration
+      layout: source
   - scope:
       path: "connections/storage/catalog"
     values:
@@ -53,4 +53,4 @@ algolia:
   application_id: UINQ2M4D9S
   index_name:     segment-docs
   files_to_exclude:
-    - _release_notes/*
+    - _release_notes/*

devguide.md

@@ -53,15 +53,19 @@ It also does some slugification and destination-name normalization, since our ha
 
 ### Layouts
 
-`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.
+`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.
+
+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.
 
 ```text
 default.html
- |- integration.html
- |- catalog.html
- |- main.html
-    |-page.html
-    |-home.html
+  |- integration.html
+    |- destination.html
+    |- source.html
+  |- main.html
+    |- catalog.html
+    |- home.html
+    |- page.html
 ```
 
 ### Platform Config API + Catalog

js/algolia/index.js

@@ -13,68 +13,74 @@ const searchClient = algoliasearch(appId, apiKey);
 insightsClient('init', { appId, apiKey });
 const algoliaInsightsPlugin = createAlgoliaInsightsPlugin({ insightsClient });
 
+// define locations to separate invocation for mobile and desktop
+const locations = ['#autocomplete','#autocomplete-mobile'];
 
-const search = autocomplete({
-  container: '#autocomplete',
-  placeholder: 'Search the Segment 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 = item.url+"#" + item.anchor;
-          } else {
-            var itemUrl = item.url;
-          }
-          return itemUrl;
-        },
-        getItems() {
-          return getAlgoliaHits({
-            searchClient,
-            queries: [
-              {
-                indexName: 'segment-docs',
-                query,
-                params: {
-                  hitsPerPage: 7,
-                  facetFilters: ['hidden:-true'],
-                  clickAnalytics: true,
-                },
-              },
-            ],
-          });
-        },
-        templates: {
-          item({ item }){
+function initAutocomplete(item){
+  const search = autocomplete({
+    container: item,
+    placeholder: 'Search the Segment documentation',
+    debug: false,
+    openOnFocus: false,
+    keyboardShortcuts: ['s', 191],
+    plugins: [algoliaInsightsPlugin,],
+    detachedMediaQuery:'none',
+    getSources( {query} ) {
+      return [
+        {
+          sourceId: 'articles',
+          getItemUrl({ item }){
             if (item.anchor != null) {
-              var anchorLink = "#" + item.anchor;
+              var itemUrl = item.url+"#" + item.anchor;
             } else {
-              var anchorLink = "";
+              var itemUrl = item.url;
             }
-            return html `<a class="aa-link" href="/docs${item.url}${anchorLink}">
-            <p class="aa-title" >${highlightHit({hit: item, attribute: 'title'})}</h3>
-            <p class="aa-heading">${item.headings.join(' >')}</p>
-            <p class="aa-content">${highlightHit({hit: item, attribute: 'content'})}</p></a>
-          `;
+            return itemUrl;
+          },
+          getItems() {
+            return getAlgoliaHits({
+              searchClient,
+              queries: [
+                {
+                  indexName: 'segment-docs',
+                  query,
+                  params: {
+                    hitsPerPage: 7,
+                    facetFilters: ['hidden:-true'],
+                    clickAnalytics: true,
+                  },
+                },
+              ],
+            });
           },
-          noResults() {
-            return html `<p class="aa-content">No results for <strong>${query}</strong></p>`;
-          }
+          templates: {
+            item({ item }){
+              if (item.anchor != null) {
+                var anchorLink = "#" + item.anchor;
+              } else {
+                var anchorLink = "";
+              }
+              return html `<a class="aa-link" href="/docs${item.url}${anchorLink}">
+              <p class="aa-title" >${highlightHit({hit: item, attribute: 'title'})}</h3>
+              <p class="aa-heading">${item.headings.join(' >')}</p>
+              <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('/docs'+itemUrl);
+      ];
     },
-  }
-});
+    navigator: {
+      navigate({ itemUrl }) {
+        window.location.assign('/docs'+itemUrl);
+      },
+    }
+  });
+  
+}
 
+locations.forEach(initAutocomplete);

src/404.html

@@ -9,7 +9,7 @@
     <div class="flex flex--justify gutter gutter--large@medium">
       <div class="flex__column flex__column--6@xlarge">  
         <div class="search">
-          {% include_cached navbar/search.html placeholder="Search the Segment documentation..." %}
+          {% include_cached navbar/search.html container="autocomplete" %}
         </div>
       </div>
 
@@ -31,7 +31,7 @@ <h1 class="page-404__heading">The page you were looking for doesn't exist.</h1>
               <p>You may have mistyped the address or the page may have moved. Double-check the URL and try again or search the term.</p>
 
               <div class="search search--mobile" data-search>
-                {% include_cached navbar/search.html placeholder="Enter a search term" mobile="true" %}
+                {% include_cached navbar/search.html container="autocomplete" %}
               </div>
             </div>
           </div>

src/_data/catalog/destination_categories.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# destination categories last updated 2021-03-10 
+# destination categories last updated 2021-04-01 
 items:
 - display_name: Email Marketing
   slug: email-marketing

src/_data/catalog/destinations.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# destination data last updated 2021-03-10 
+# destination data last updated 2021-04-01 
 items:
 - display_name: ActiveCampaign
   slug: activecampaign
@@ -16689,6 +16689,59 @@ items:
       server: false
   previous_names:
   - Pingdom
+- display_name: Pinterest Audiences
+  slug: pinterest-audiences
+  name: catalog/destinations/pinterest-audiences
+  description: >-
+    The Pinterest Audiences integration lets you add user audiences for
+    remarketing.
+  hidden: false
+  url: connections/destinations/catalog/pinterest-audiences
+  status: PUBLIC
+  logo:
+    url: 'https://cdn.filepicker.io/api/file/p3vCawmQ2CtnbacRnRHD'
+  mark:
+    url: 'https://cdn.filepicker.io/api/file/GBX5NV3USYmSOcpePkA1'
+  categories:
+  - Advertising
+  components:
+  - type: CLOUD
+  platforms:
+    browser: false
+    server: true
+    mobile: false
+  browserUnbundlingSupported: false
+  browserUnbundlingPublic: true
+  methods:
+    alias: false
+    group: false
+    identify: false
+    page_view: false
+    track: true
+  settings:
+  - name: account
+    display_name: account
+    type: STRING
+    deprecated: false
+    required: true
+    string_validators:
+      regexp: ^\d+$
+    description: >-
+      You can find your Account ID on the **Account Settings** page of your
+      [Pinterest Ads account](https://ads.pinterest.com/). It should be a series
+      of numbers, like `319762813599`.
+    settings: []
+  connection_modes:
+    device:
+      web: false
+      mobile: false
+      server: false
+    cloud:
+      web: false
+      mobile: true
+      server: true
+  previous_names:
+  - Pinterest Audiences
 - display_name: Pinterest Tag
   slug: pinterest-tag
   name: catalog/destinations/pinterest-tag
@@ -17956,24 +18009,6 @@ items:
       required: false
       description: Map your Segment properties to Responsys Columns
       settings:
-      - name: columns
-        display_name: Segment Property Name
-        type: STRING
-        deprecated: false
-        required: true
-        string_validators:
-          regexp: ''
-        description: Enter the Segment Property Name.
-        settings: []
-      - name: fieldName
-        display_name: Responsys Column Name
-        type: STRING
-        deprecated: false
-        required: true
-        string_validators:
-          regexp: ''
-        description: Enter the Responsys column name.
-        settings: []
       - name: fieldType
         display_name: Responsys Column Type
         type: SELECT
@@ -17998,6 +18033,24 @@ items:
         required: false
         description: Mark this property as a Primary Key in Responsys.
         settings: []
+      - name: columns
+        display_name: Segment Property Name
+        type: STRING
+        deprecated: false
+        required: true
+        string_validators:
+          regexp: ''
+        description: Enter the Segment Property Name.
+        settings: []
+      - name: fieldName
+        display_name: Responsys Column Name
+        type: STRING
+        deprecated: false
+        required: true
+        string_validators:
+          regexp: ''
+        description: Enter the Responsys column name.
+        settings: []
     - name: mapEmail
       display_name: Map Email
       type: BOOLEAN
@@ -22980,9 +23033,9 @@ items:
     url: >-
       https://public-segment-devcenter-production.s3.amazonaws.com/b6a1db0f-1b55-4651-9cc5-d78d8365a447.svg
   categories:
+  - Surveys
   - Customer Success
   - Analytics
-  - Surveys
   - Personalization
   components: []
   platforms:

src/_data/catalog/source_categories.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# source cateogries last updated 2021-03-10 
+# source cateogries last updated 2021-04-01 
 items:
 - display_name: Server
   slug: server

src/_data/catalog/sources.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# sources last updated 2021-03-10 
+# sources last updated 2021-04-01 
 items:
 - display_name: .NET
   slug: net