Merge pull request #875 from segmentio/functions-rewrite

Rewrite docs for Functions

Author: Andy

src/_data/sidenav/main.yml

@@ -144,8 +144,6 @@ sections:
       title: All about Cloud Sources
     - path: /connections/sources/custom-domains
       title: Set up a custom domain proxy in Segment
-    - path: /connections/sources/source-functions
-      title: Source Functions
     - path: /connections/sources/visual-tagger
       title: Visual Tagger
   - section_title: Destinations
@@ -158,8 +156,19 @@ sections:
       menu_icon: read-more
     - path: /connections/destinations/destination-filters
       title: Destination Filters
-    - path: /connections/destinations/destination-functions
+  - section_title: Functions
+    slug: connections/functions
+    section:
+    - path: /connections/functions
+      title: Functions Overview
+    - path: /connections/functions/source-functions
+      title: Source Functions
+    - path: /connections/functions/destination-functions
       title: Destination Functions
+    - path: /connections/functions/environment
+      title: Functions environment
+    - path: /connections/functions/usage
+      title: Functions usage limits
   - section_title: Data Storage
     slug: connections/storage
     section:

src/_includes/content/functions/perms.md

@@ -0,0 +1,8 @@
+Functions have specific roles which can be used for [access management](/docs/segment-app/iam/) in your Segment workspace.
+
+Access to functions is controlled by two permissions [roles](/docs/segment-app/iam/roles/):
+
+- **Functions Admin:** Create, edit and delete all functions, or a subset of specified functions.
+- **Functions Read-only:** View all functions, or a subset of specified functions.
+
+You also need additional **Source Admin** permissions to enable source functions, connect destination functions to a source, or to deploy changes to existing functions.

src/_includes/content/functions/runtime.md

@@ -0,0 +1,16 @@
+Functions use Node.js 10.x.
+
+Functions do not currently support importing dependencies, but you can [contact Segment Support](https://segment.com/help/contact/) to request that one be added.
+
+The following dependencies are installed in the function environment by default.
+
+- [`atob v2.1.2`](https://www.npmjs.com/package/atob) exposed as `atob`
+- [`aws-sdk v2.488.0`](https://www.npmjs.com/package/aws-sdk) exposed as `AWS`
+- [`btoa v1.2.1`](https://www.npmjs.com/package/btoa) exposed as `btoa`
+- [`form-data v2.4.0`](https://www.npmjs.com/package/form-data) exposed as `FormData`
+- [`lodash v4.17.15`](https://www.npmjs.com/package/lodash) exposed as `_`
+- [`node-fetch v2.6.0`](https://www.npmjs.com/package/node-fetch) exposed as `fetch`
+- [`oauth v0.9.15`](https://www.npmjs.com/package/oauth) exposed as `OAuth`
+- [`xml v1.0.1`](https://www.npmjs.com/package/lodash) exposed as `xml`
+
+Only the [`crypto` Node.js module](https://nodejs.org/dist/latest-v10.x/docs/api/crypto.html ) is included (exposed as `crypto`). [Other built-in Node.js modules](https://nodejs.org/api/modules.html) are not available.

src/_includes/content/functions/settings.md

@@ -0,0 +1,28 @@
+<!-- usually placed under a heading called "Settings and Secrets" -->
+
+Settings allow you to pass configurable variables to your function, which is the best way to pass sensitive information such as security tokens. For example, you might use `settings` as placeholders to use information such as an API endpoint and API key. This way, you can use the same code with different settings for different purposes. When you deploy a function in your workspace, you are prompted to fill out these settings to configure the function.
+
+First, add a setting in **Settings** tab in the code editor:
+
+![Settings Tab](/docs/connections/functions/images/settings-tab-empty.jpg){:width="500"}
+
+Click **Add Setting** to add your new setting.
+
+![Add Setting Dialog](/docs/connections/functions/images/add-setting-dialog.jpg)
+
+You can configure the details about this setting, which change how it's displayed to anyone using your function:
+
+- **Label** - Name of the setting, which users see when configuring the function.
+- **Name** - Auto-generated name of the setting to use in function's source code.
+- **Type** - Type of the setting's value.
+- **Description** - Optional description, which appears below the setting name.
+- **Required** - Enable this to ensure that the setting cannot be saved without a value.
+- **Encrypted** - Enable to encrypt the value of this setting. Use this setting for sensitive data, like API keys.
+
+As you change the values, a preview to the right updates to show how your setting will look and work.
+
+Click **Add Setting** to save the new setting.
+
+Once you save a setting, it appears in the **Settings** tab for the function. You can edit or delete settings from this tab.
+
+![Settings Tab](/docs/connections/functions/images/settings-tab-non-empty.jpg){:width="500"}