Merge pull request #555 from segmentio/repo-sync

repo sync

Author: bot-docsteam

src/_data/glossary.yml

@@ -2,7 +2,7 @@ Analytics.js: |
   The Segment Javascript library wrapper, which makes it simple to send your data to any tool without having to learn, test or implement the new API for each tool every time.
 
 API: |
-  Application Programming Interface. In software, this term describes a way of interacting with software in an automated fashion, without the use of a user-interface designed for humans. In Segment, we call the standard calls (`track`, `page` and `screen`, `identify` and `group`) our API. We also provide the [Config API](/docs/config-api/), which you can use to configure sources and destinations, and perform other functions in your workspace, without logging in using a web browser.
+  Application Programming Interface. In software, this term describes a way of interacting with software in an automated fashion, without the use of a user-interface designed for humans. In Segment, we call the standard calls (`track`, `page` and `screen`, `identify` and `group`) our API. We also provide the [Public API](/docs/api/), which you can use to configure sources and destinations, and perform other functions in your workspace, without logging in using a web browser.
 
 App: |
   The app is what we call the main Segment web application, the part you log in to, and where you configure sources and destinations, see events in the debugger, manage your tracking plan, and so on.

src/_data/sidenav/main.yml

@@ -407,3 +407,23 @@ sections:
     title: Prod and Testing Environments in Segment
   - path: /segment-app/verify-email-address
     title: Verifying Your Email Address
+- section_title: API
+  section:
+  - path: /api/public-api
+    title: Public API
+  - section_title: Config API
+    slug: api/config-api
+    section:
+    - path: /api/config-api
+      title: Config API overview
+    - path: /api/config-api/api-design
+      title: API design
+    - path: /api/config-api/authentication
+      title: Authentication
+    - path: /api/config-api/fql
+      title: Destination Filter Query Language
+    # - path: "https://reference.segmentapis.com/"
+    #   title: Reference
+    #   menu_icon: new-tab
+  # - path: /config-api/tutorial-javascript-google-analytics
+  #   title: Creating a Javascript web source and Google Analytics destination

src/_includes/content/papi-ga.html

@@ -0,0 +1,8 @@
+<div class="premonition success">
+  <div class="fa fa-info-circle"></div>
+  <div class="content">
+    <p class="header">The Segment Public API is available</p>
+    <p markdown=1>Segment's [Public API](/docs/api) is available to use. You can use the Public API and Config APIs in parallel, but moving forward any API updates will come to the Public API exclusively. </p>
+    <p markdown=1>Please contact your account team or [[email protected]](mailto:[email protected]) with any questions.</p>
+  </div>
+</div>

src/_includes/icons/api.svg

@@ -3,19 +3,6 @@
 <div class="sidebar">
   <div class="sidebar__content">
     {% include menu/menu-primary.html %}
-
-    <nav class="menu">
-      <ul class="list list--unstyle">
-        <li class="menu-item">
-          <a class="menu-item__link menu-item__link--highlight menu-item__link--icon flex flex--middle" href="{{ site.baseurl }}/config-api/">
-            <div class="menu-item__icon flex__column">
-              {% include icons/config-api.svg %}
-            </div>
-
-            <div class="flex__column">Config API</div>
-          </a>
-        </li>
-
         <li class="menu-item {% if currentPage == "help" %}menu-item--active{% endif %}">
           <a class="menu-item__link menu-item__link--highlight menu-item__link--icon flex flex--middle" href="{{ site.baseurl }}/help/">
             <div class="menu-item__icon flex__column">

src/_includes/menu/menu.html

@@ -14,8 +14,6 @@
         {% include menu/menu-glossary.html %}
       {% elsif currentPage[1] == 'partners' %}
         {% include menu/menu-partners.html %}
-      {% elsif currentPage[1] == 'config-api' %}
-      {% include menu/menu-config-api.html %}
       {% else %}
         {% include menu/menu.html %}
       {% endif %}

src/_layouts/main.html

@@ -152,13 +152,16 @@
         top: 0;
         left: 0;
       }
+
       div.highlighter-rouge {
         margin: 15px auto;
         position: relative;
       }
+
       table {
         margin: 15px auto;
       }
+
       &>ul,
       ol {
         margin-top: 0;
@@ -213,6 +216,14 @@
         line-height: 1.5;
         padding: 24px;
       }
+
+      img {
+        border: none;
+        display: inline;
+        margin: 0;
+        vertical-align: inherit;
+      }
+
     }
 
     thead {
@@ -309,7 +320,7 @@
 }
 
 //a[target="_blank"]:not(.reference-button):after {
-  //content: url("/docs/images/external-link-alt-solid.svg");
+//content: url("/docs/images/external-link-alt-solid.svg");
 //  margin-left: 4px;
 //}
 
@@ -406,12 +417,14 @@ div.highlighter-rouge {
     right: 0;
     border-radius: 0 0.15rem;
     width: 40px;
+
     img {
       width: 16px;
       margin: 0;
       border: none;
       border-radius: 0px;
     }
+
     img:hover {
       filter: invert(65%) sepia(9%) saturate(784%) hue-rotate(192deg) brightness(91%) contrast(87%);
       transition: 0.2s ease-out;
@@ -422,7 +435,7 @@ div.highlighter-rouge {
     }
   }
 
-  .green{
+  .green {
     background-color: #BAE5D5;
     content: "copied!";
   }

src/_sass/components/_markdown.scss

@@ -2,6 +2,8 @@
 title: API Design
 ---
 
+{% include content/papi-ga.html %}
+
 ## API Evolution: Versioning and Compatibility
 
 Segment strives to maintain a strict contract around the stability of our APIs once they reach maturity.

src/config-api/api-design.md src/api/config-api/api-design.mdsrc/config-api/api-design.md renamed to src/api/config-api/api-design.md

@@ -2,6 +2,9 @@
 title: Authentication
 ---
 
+{% include content/papi-ga.html %}
+
+
 You can access the Config API programmatically using access tokens. When you authenticate with an access token, you have access to any resource and permission assigned to the token.
 
 ## Create an Access Token

src/config-api/authentication.md src/api/config-api/authentication.mdsrc/config-api/authentication.md renamed to src/api/config-api/authentication.md

@@ -2,6 +2,9 @@
 title: Destination Filter Query Language
 ---
 
+{% include content/papi-ga.html %}
+
+
 Destination Filter Reference documentation can be found in the [main Config API reference docs](https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5).
 
 Filter Query Language ("FQL") is a simple language for filtering JSON objects used by the Transformations API to conditionally apply transformations. In the Transformations API, FQL statements evaluate to `true` or `false` based on the contents of each Segment event. If the statement evaluates to `true`, the transformation is applied, and if it is `false` the transformation is not applied.