-
Notifications
You must be signed in to change notification settings - Fork 382
Rewrite docs for Functions #875
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
83 commits
Select commit
Hold shift + click to select a range
953cf2f
Move directory and update Destination Functions
misteryeo 8778aea
Updates Source Functions
misteryeo 8e29376
Adds Functions Overview page
misteryeo 75d7ec2
Updates side nav for Functions
misteryeo dea63b7
Update src/connections/functions/source-functions/index.md
1fafe92
Update src/connections/functions/source-functions/index.md
4c4db13
Update src/connections/functions/index.md
3eb40aa
Update src/connections/functions/index.md
890cc2b
Update src/connections/functions/source-functions/index.md
8c439b4
Update src/connections/functions/source-functions/index.md
99db641
Update src/connections/functions/source-functions/index.md
5d700cb
Update src/connections/functions/source-functions/index.md
ed8bb21
Update src/connections/functions/destination-functions/index.md
e8719dc
Update src/connections/functions/destination-functions/index.md
189ca20
Update src/connections/functions/destination-functions/index.md
379666e
Update src/connections/functions/index.md
b1c6795
Update src/connections/functions/source-functions/index.md
137b85b
Update src/connections/functions/source-functions/index.md
29d79a2
Update src/connections/functions/source-functions/index.md
214a29e
Merge branch 'master' into functions-rewrite
056f1c2
Updates from first round of feedback
misteryeo 4548e7e
Merge branch 'master' into functions-rewrite
d2f2826
Update overview
misteryeo 054b3fc
Merge branch 'functions-rewrite' of ssh://github.com/segmentio/segmen…
misteryeo 11c0e7b
Update src/connections/functions/source-functions/index.md
55a1b54
Update src/connections/functions/index.md
6e2c1e4
Update src/connections/functions/index.md
79ec75a
Update src/connections/functions/index.md
ee20920
Update src/connections/functions/source-functions/index.md
611d24c
Update src/connections/functions/source-functions/index.md
41a6e8c
Further feedback
misteryeo a672b53
Merge branch 'master' into functions-rewrite
8c024d7
Merge branch 'master' into functions-rewrite
613f044
Adds new images
misteryeo 5cf6af0
Update images
misteryeo f77c93a
Merge branch 'master' into functions-rewrite
sanscontext 9f9dd4c
Final changes
misteryeo 2924cc1
Merge branch 'functions-rewrite' of ssh://github.com/segmentio/segmen…
misteryeo 94c7fdd
Extend new source function docs (#886)
db114af
Extend new destination function docs (#887)
89ed59b
Merge branch 'master' into functions-rewrite
sanscontext 093a8bf
Destination Functions: Document caching strategy
tysonmote d0929ca
Lr functions edits (#911)
sanscontext a99602a
restore caching section which got dropped during merge >_<
9b0eb73
more merge cleanup
ab1c30a
update file
9a0ce42
Merge branch 'master' into functions-rewrite
816398b
Copy edits on usage page
f5a8aba
add link to pricing
8b77c64
remove duplicates
85ba6f9
fix fragment
ca559cf
fix format, reorder
3118a97
update save and deploy
765aca5
Update src/connections/functions/usage.md
sanscontext 9b51c98
Update src/connections/functions/usage.md
sanscontext b88d4a3
Update src/connections/functions/usage.md
sanscontext 5049150
Merge branch 'master' into functions-rewrite
sanscontext 75dfef5
Update src/connections/functions/usage.md
sanscontext 678de77
Update src/connections/functions/destination-functions.md
sanscontext bd1c12f
Update src/connections/functions/environment.md
sanscontext 6dd713a
Update src/connections/functions/source-functions.md
sanscontext 57ca3b9
Update src/connections/functions/source-functions.md
sanscontext 23ce3e5
Update src/connections/functions/source-functions.md
sanscontext 5dbc827
Update src/connections/functions/source-functions.md
sanscontext 99d8024
Update src/connections/functions/usage.md
sanscontext fd0b1b3
Update src/connections/functions/usage.md
sanscontext b2c31f6
Update src/connections/functions/usage.md
sanscontext 61503eb
Update src/connections/functions/source-functions.md
sanscontext cdb7182
Update src/connections/functions/source-functions.md
sanscontext 2eb6245
Update src/connections/functions/usage.md
sanscontext f519a9c
Update src/connections/functions/usage.md
sanscontext a63764b
Update src/connections/functions/usage.md
sanscontext 6424980
functions: Fix caching example
tysonmote 6528291
Merge branch 'master' into functions-rewrite
bacdb98
Final polish for GA
misteryeo 29916e0
Update src/connections/functions/usage.md
498853c
batch edit note!
f436b11
Apply suggestions from code review
sanscontext fc5be56
Update src/connections/functions/destination-functions.md
4c569f4
Update src/connections/functions/destination-functions.md
8f197a0
Apply suggestions from code review
4ef437b
Merge branch 'master' into functions-rewrite
sanscontext 0eda5b8
Merge branch 'master' into functions-rewrite
sanscontext File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: | ||
|
||
{:width="500"} | ||
|
||
Click **Add Setting** to add your new setting. | ||
|
||
 | ||
|
||
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. | ||
|
||
{:width="500"} |
Binary file removed
BIN
-132 KB
src/connections/destinations/destination-functions/images/editor.png
Binary file not shown.
Binary file removed
BIN
-29.4 KB
src/connections/destinations/destination-functions/images/visual.png
Binary file not shown.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.