Merge pull request #6915 from segmentio/thomas/betatags-partnerowned

Remove beta tags frontmatter and and autopopulate partner owned for sources

Author: pwseg

scripts/catalog/updateSources.js

@@ -14,28 +14,28 @@ const PAPI_URL = "https://api.segmentapis.com";
 
 const regionalSupport = yaml.load(fs.readFileSync(path.resolve(__dirname, `../../src/_data/regional-support.yml`)));
 
-// This file keeps a list of known test sources that show up in the system. 
+// This file keeps a list of known test sources that show up in the system.
 // Because we don't have a status value for sources, they end up showing in our catalog.
 // We use this below to prevent them from being written to yaml.
 const testSources = yaml.load(fs.readFileSync(path.resolve(__dirname, `../../src/_data/catalog/test_sources.yml`)));
 
 
 const updateSources = async () => {
-    let sources = [];                     // Initialize an empty array to hold all sources  
-    let sourcesUpdated = [];              // Initialize an empty array to hold all sources that have been updated    
-    let regionalSourcesUpdated = [];      // Initialize an empty array to hold updated source regional information            
-    let nextPageToken = "MA==";           // Set the initial page token to the first page      
-    let categories = new Set();           // Initialize an empty set to hold all categories      
-    let sourceCategories = [];            // Initialize an empty array to hold all source categories      
-  
-  
+    let sources = [];                     // Initialize an empty array to hold all sources
+    let sourcesUpdated = [];              // Initialize an empty array to hold all sources that have been updated
+    let regionalSourcesUpdated = [];      // Initialize an empty array to hold updated source regional information
+    let nextPageToken = "MA==";           // Set the initial page token to the first page
+    let categories = new Set();           // Initialize an empty set to hold all categories
+    let sourceCategories = [];            // Initialize an empty array to hold all source categories
+
+
     // Get all sources from the catalog
     while (nextPageToken !== undefined) {
       const res = await getCatalog(`${PAPI_URL}/catalog/sources/`, nextPageToken);
       sources = sources.concat(res.data.sourcesCatalog);
       nextPageToken = res.data.pagination.next;
     }
-  
+
     // Sort the sources alphabetically
     sources.sort((a, b) => {
       if (a.name.toLowerCase() < b.name.toLowerCase()) {
@@ -46,7 +46,7 @@ const updateSources = async () => {
       }
       return 0;
     });
-  
+
     // Set the list of categories for libraries
     const libraryCategories = [
       'server',
@@ -55,20 +55,20 @@ const updateSources = async () => {
       'roku',
       'website'
     ];
-  
+
     // Here, define some sources that are real, but that we want to hide.
     const hiddenSources = [
       'amp',
       'factual-engine',
       'twilio-event-streams-beta',
       'ibm-watson-assistant'
     ];
-  
+
     // More regional stuff
     const regionalSourceEndpoint = regionalSupport.sources.endpoint;
     const regionalSourceRegion = regionalSupport.sources.region;
-  
-    
+
+
     // Loop through all sources and create a new object with the data we want
     sources.forEach(source => {
       let slug = slugify(source.name, "sources");
@@ -77,14 +77,14 @@ const updateSources = async () => {
       let regions = ['us'];
       let endpoints = ['us'];
       let mainCategory = source.categories[0] ? source.categories[0].toLowerCase() : '';
-  
+
       if (libraryCategories.includes(mainCategory)) {
         url = `connections/sources/catalog/libraries/${mainCategory}/${slug}`;
       } else {
         url = `connections/sources/catalog/cloud-apps/${slug}`;
         mainCategory = 'cloud-app';
       }
-  
+
       // Sort the settings alphabetically
       settings.sort((a, b) => {
         if (a.name.toLowerCase() < b.name.toLowerCase()) {
@@ -95,19 +95,19 @@ const updateSources = async () => {
         }
         return 0;
       });
-  
+
       if (hiddenSources.includes(slug)) {
         hidden = true;
       }
-  
+
       if (regionalSourceEndpoint.includes(slug)) {
         endpoints.push('eu');
       }
-  
+
       if (regionalSourceRegion.includes(slug)) {
         regions.push('eu');
       }
-  
+
       // If the source ID is in the list of test sources, skip it.
       // If it's not, add it to the list of sources to be written to yaml.
       if (testSources.includes(source.id)) {
@@ -128,13 +128,15 @@ const updateSources = async () => {
             url: source.logos.default
           },
           categories: source.categories,
+          status: source.status,
+          partnerOwned: source.partnerOwned
         };
         sourcesUpdated.push(updatedSource);
         doesCatalogItemExist(updatedSource);
       }
-  
+
       source.categories.reduce((s, e) => s.add(e), categories);
-  
+
       // Sources don't yet have regional information in the Public API, so we write that info here.
       let updatedRegional = {
         id: source.id,
@@ -147,7 +149,7 @@ const updateSources = async () => {
       };
       regionalSourcesUpdated.push(updatedRegional);
     });
-  
+
     const sourceArray = Array.from(categories);
     sourceArray.forEach(category => {
       sourceCategories.push({
@@ -164,36 +166,36 @@ const updateSources = async () => {
         return 0;
       });
     });
-  
+
     const options = {
       noArrayIndent: false
     };
     const todayDate = new Date().toISOString().slice(0, 10);
-  
+
     // Create source catalog YAML file
     let output = "# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT\n";
     output += "# sources last updated " + todayDate + " \n";
     output += yaml.dump({
       items: sourcesUpdated
     }, options);
     fs.writeFileSync(path.resolve(__dirname, `../../src/_data/catalog/sources.yml`), output);
-  
+
     // Create source-category mapping YAML file
     output = "# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT\n";
     output += "# source categories last updated " + todayDate + " \n";
     output += yaml.dump({
       items: sourceCategories
     }, options);
     fs.writeFileSync(path.resolve(__dirname, `../../src/_data/catalog/source_categories.yml`), output);
-  
+
     // Create regional support YAML file
     output = yaml.dump({
       sources: regionalSourcesUpdated
     }, options);
     fs.writeFileSync(path.resolve(__dirname, `../../src/_data/catalog/regional-supported.yml`), output);
-  
+
     console.log("sources done");
   };
 
 
-  exports.updateSources = updateSources;
+  exports.updateSources = updateSources;

scripts/catalog/utilities.js

@@ -133,11 +133,7 @@ const doesCatalogItemExist = (item) => {
     let content = `---\ntitle: '${item.display_name} Source'\nhidden: true\n---`;
 
     if (!docsPath.includes('/sources/')) {
-      let betaFlag = '';
-      if (item.status === 'PUBLIC_BETA') {
-        betaFlag = 'beta: true\n';
-      }
-      content = `---\ntitle: '${item.display_name} Destination'\nhidden: true\nid: ${item.id}\npublished: false\n${betaFlag}---\n`;
+      content = `---\ntitle: '${item.display_name} Destination'\nhidden: true\nid: ${item.id}\npublished: false\n`;
     }
 
     fs.mkdirSync(docsPath);
@@ -172,4 +168,4 @@ exports.getCatalog = getCatalog;
 exports.getConnectionModes = getConnectionModes;
 exports.isCatalogItemHidden = isCatalogItemHidden;
 exports.sanitize = sanitize;
-exports.doesCatalogItemExist = doesCatalogItemExist;
+exports.doesCatalogItemExist = doesCatalogItemExist;

src/_data/catalog/beta_sources.yml

@@ -2,11 +2,40 @@
 {% assign currentIntegration = site.data.catalog.sources.items | where: "slug", currentSlug | first %}
 {% if currentIntegration.url contains "cloud-apps" or page.path contains "cloud-apps" %}
 {% if currentIntegration.isCloudEventSource  %}
-<div class="premonition success"><div class="fa fa-check-square"></div><div class="content"><p class="header">Good to know: Event Cloud source</p>
-<p markdown=1>The {{ page.title }} is an **event** source. This means that it sends data as events, which are behaviors or occurrences tied to a user and a point in time. Data from these sources can be loaded into your Segment warehouses, and **also** sent to  Segment streaming destinations. [Learn more about cloud sources.](/docs/connections/sources/#cloud-apps)</p>
-</div></div>
-{% else %}
 
-<div class="premonition success"><div class="fa fa-check-square"></div><div class="content"><p class="header">Good to know: Object Cloud source</p><p markdown=1>The {{ page.title }} is an **object** source. This means that it sends information (traits) about a thing that exists and persists over time, such as a person or company, and which can be updated over time. Data from this source can only be exported directly to a warehouse, but it can then be used for further analysis. [Learn more about cloud sources.](/docs/connections/sources/#cloud-apps)</p></div></div>
+<div class="quick-info">
+  <div class="qi-content">
+    <h6>Source Info</h6>
+    <ul class="qi">
+      <li><p markdown=1>The {{ page.title }} is an **Event Cloud** source. This means that it sends data as events, which are behaviors or occurrences tied to a user and a point in time. Data from these sources can be loaded into your Segment warehouses, and **also** sent to  Segment streaming destinations. [Learn more about cloud sources.](/docs/connections/sources/#cloud-apps)</p></li>
+      {% if currentIntegration.status == "PUBLIC_BETA" %}<li>This source is in <span class="release-pill">Beta</span></li>{%endif%}
+    </ul>
+    {% if currentIntegration.partnerOwned %}
+    <h6>Partner Owned</h6>
+    <ul class="qi">
+      <li>This integration is partner owned. Please reach out to the partner's support for any issues.</li>
+    </ul>
+    {% endif %}
+  </div>
+</div>
+
+{% else %}
+<div class="quick-info">
+  <div class="qi-content">
+    <h6>Source Info</h6>
+    <ul class="qi">
+      <li><p markdown=1>The {{ page.title }} is an **Object Cloud** source. This means that it sends information (traits) about a thing that exists and persists over time, such as a person or company, and which can be updated over time. Data from this source can only be exported directly to a warehouse, but it can then be used for further analysis. [Learn more about cloud sources.](/docs/connections/sources/#cloud-apps)</p></li>
+      {% if currentIntegration.status == "PUBLIC_BETA" %}<li>This source is in <span class="release-pill">Beta</span></li>{%endif%}
+    </ul>
+    {% if currentIntegration.partnerOwned %}
+    <h6>Partner Owned</h6>
+    <ul class="qi">
+      <li>This integration is partner owned. Please reach out to the partner's support for any issues.</li>
+    </ul>
+    {% endif %}
+  </div>
+</div>
 {% endif %}
 {% endif %}
+
+

src/_includes/content/cloud-app-note.md

@@ -1,7 +1,6 @@
 ---
 title: 1Flow Mobile Plugin Destination
 id: 64dd07c1fed86b6866cd93f5
-beta: true
 ---
 
 [1Flow](https://1flow.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses.

src/connections/destinations/catalog/1flow-mobile-plugin/index.md

@@ -2,7 +2,6 @@
 rewrite: true
 title: AB Tasty Destination
 id: 6214f1347a49cda426260372
-beta: true
 ---
 
 # AB Tasty Destination

src/connections/destinations/catalog/ab-tasty-client-side/index.md

@@ -5,7 +5,6 @@ hide-boilerplate: true
 hide-dossier: false
 private: true
 hidden: true
-beta: true
 id: 643697130067c2f408ff28ca
 redirect_from:
   - "/connections/destinations/catalog/actions-rokt-audiences" 
@@ -69,4 +68,4 @@ Your Rokt Audiences (Actions) destination is now ready to receive audiences, and
 > warning ""
 > You can only connect **one** Engage audience to a single instance of the Rokt Audience (Actions) destination. If you have multiple audiences, repeat the above process to create a new Rokt Audience (Actions) destination and connect the audience to a new destination each time.
 
-{% include components/actions-fields.html %}
+{% include components/actions-fields.html %}

src/connections/destinations/catalog/action-rokt-audiences/index.md

@@ -1,7 +1,6 @@
 ---
 title: 1Flow Web (Actions) Destination
 id: 656773f0bd79a3676ab2733d
-beta: true
 ---
 
 {% include content/plan-grid.md name="actions" %}
@@ -47,4 +46,4 @@ The 1Flow destination automatically ingests any user actions tracked over your T
 If you are seeing 404 responses in your browser's network tab, you've likely encountered one of two issues:
 
 - You set the wrong App ID on the 1Flow Actions (Web) destination settings page.
-- You set the wrong Regional Data Hosting value on the 1Flow Actions (Web) destination settings page. 1Flow gates regional endpoints by plan level, so you may not have access to EU data hosting.
+- You set the wrong Regional Data Hosting value on the 1Flow Actions (Web) destination settings page. 1Flow gates regional endpoints by plan level, so you may not have access to EU data hosting.

src/connections/destinations/catalog/actions-1flow/index.md

@@ -1,7 +1,6 @@
 ---
 title: Aggregations.io (Actions) Destination
 id: 659eb601f8f615dac18db564
-beta: true
 ---
 
 {% include content/plan-grid.md name="actions" %}
@@ -18,4 +17,4 @@ This destination is maintained by Aggregations.io. For any issues with the desti
 4. Select an existing Source to connect to Aggregations.io (Actions).
 5. In the destination settings, enter your Aggregations.io API Key and Ingest ID. Your ingestion on the Aggregations.io dashboard should be set up using `Array of JSON Objects` and the API Key requires `Write` permission.  For more information, see the [Aggregation.io docs](https://aggregations.io/docs/ingesting-data/create-an-ingest){:target="_blank"}.
 
-{% include components/actions-fields.html %}
+{% include components/actions-fields.html %}

src/connections/destinations/catalog/actions-aggregations-io/index.md

@@ -1,7 +1,6 @@
 ---
 title: Amazon Ads DSP and AMC Destination
 id: 66543798b2fb3cb3e9ff992c
-beta: true
 ---
 
 {% include content/plan-grid.md name="actions" %}