Update Function Docs to reflect new UI #558

misteryeo · 2020-01-28T17:44:31Z

Proposed changes

Updated naming and set-up redirects 🤞(checking with #segment-docs on the correct process)
Removed old notes and features that no longer apply in new UI
Added Legacy Source section highlighting changes in class vs instance model
Created alignment in structure across both docs

To Do

Update screenshots for new UI
Have team validate the technical functionality described in docs
Verify that redirects work

Related issues (optional)

Closes https://segment.atlassian.net/browse/FUN-460

src/_data/sidenav/main.yml

src/connections/destinations/destination-functions/index.md

vadimdemedes · 2020-01-28T18:20:35Z

src/connections/destinations/destination-functions/index.md


 - **Callback Return** - This shows what data the function returned, or the error it threw.
 - **Log Output** - The raw log. Any messages to `console.log()` from the function appear here.

+## Creation & Deployment
+
+Once you're satisfied with your Destination Function, you can deploy your code by clicking the `Configure` button on the bottom right of the editor. This brings you to a screen to name your function and optionally add additional details that will be displayed in your workspace. Hit `Create Function` and your Destination Function will be ready to be used within your workspace.


Once you're satisfied with your Destination Function, you can deploy your code by clicking the Configure button on the bottom right of the editor. - that's not accurate. When you create a destination function, you don't deploy it, you only create a class in the catalog. Then, users need to connect destinations to sources, which will deploy an instance. @chriso is this correct?

Made some updates here but would need clarification from @chriso on the piece when I'm editing a function and click Save & Deploy - what's the status. My understanding was even at that point, we're not deploying to instances so actually the button shouldn't say Save & Deploy technically speaking, right? cc: @vadimdemedes

Destination function instances all use code from the class, so if you save your function, you're implicitly "deploying" it.

With source functions, the save and deploy steps are two separate things. Updating the class doesn't automatically update instances; you have to deploy changes to them.

src/connections/destinations/destination-functions/index.md

Co-Authored-By: Vadim Demedes <[email protected]>

src/connections/sources/source-function.md

Co-Authored-By: Vadim Demedes <[email protected]>

src/connections/destinations/destination-functions/index.md

src/connections/sources/source-function.md

Co-Authored-By: Vadim Demedes <[email protected]>

… new-ui

src/connections/destinations/destination-functions/index.md

src/connections/sources/source-functions.md

src/connections/destinations/destination-functions/index.md

sanscontext

Ugh sorry these comments got stuck in "review limbo"

src/connections/destinations/destination-functions/index.md

… new-ui

src/connections/sources/source-functions/index.md

src/connections/destinations/destination-functions/index.md

vadimdemedes · 2020-01-29T18:56:06Z

src/connections/destinations/destination-functions/index.md

+The JavaScript below builds a query string for the URL, sets a basic auth header, and sends a JSON body.
+
+```js
+const endpoint = "https://REDACTED.x.example.com"


Please use single quotes here and in the rest of examples for consistency.

src/connections/destinations/destination-functions/index.md

vadimdemedes · 2020-01-29T18:57:36Z

src/connections/destinations/destination-functions/index.md

+
+```js
+async function onGroup(event, settings) {
+  if (!event.company) {


There's no company field on the group event (or any other event).

vadimdemedes · 2020-01-29T18:58:52Z

src/connections/destinations/destination-functions/index.md

+
+```js
+async function onRequest(request, settings) {
+  let settingValue = settings.settingKey;


Suggested change

let settingValue = settings.settingKey;

// Retrieve value of a setting `settingKey`

const settingValue = settings.settingKey;

vadimdemedes · 2020-01-29T18:59:16Z

src/connections/sources/source-functions/index.md

+You can access header data using the `request.headers` property and the [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers) interface. For example:"
+
+```js
+async function onRequest(request, settings) {


Suggested change

async function onRequest(request, settings) {

function onRequest(request, settings) {

vadimdemedes · 2020-01-29T18:59:35Z

src/connections/sources/source-functions/index.md

+
+```js
+async function onRequest(request, settings) {
+  const requestHeader = request.headers.get('Content-Type')


Suggested change

const requestHeader = request.headers.get('Content-Type')

const contentType = request.headers.get('Content-Type')

src/connections/sources/source-functions/index.md

vadimdemedes · 2020-01-29T19:00:20Z

src/connections/sources/source-functions/index.md


 ```js
 async function onRequest(request, settings) {
-  const requestHeader = request.headers.get('Content-Type')
+  let settingValue = settings.settingKey;


Suggested change

let settingValue = settings.settingKey;

// Retrieve value of a setting "settingKey"

const settingValue = settings.settingKey;

Co-Authored-By: Vadim Demedes <[email protected]>

repo sync

misteryeo added 6 commits January 27, 2020 18:51

Update naming on all Function docs

e3e3077

Updates Destination Function docs

c53487e

Update wording

5a273e5

Update Destination Functions

feb71fb

Update Source Functions

93a3ce5

Update redirects :fingers-crossed:

b7436c5

misteryeo requested review from tysonmote, chriso, kamebkj, vadimdemedes, kellymtrinh, sanscontext and kalamay January 28, 2020 17:44

misteryeo added 2 commits January 28, 2020 10:02

Update Source Function in nav

c7587d8

Update title

35d09d0

vadimdemedes suggested changes Jan 28, 2020

View reviewed changes

Andy and others added 2 commits January 28, 2020 10:46

Update src/_data/sidenav/main.yml

1c959bb

Co-Authored-By: Vadim Demedes <[email protected]>

Update src/_data/sidenav/main.yml

d5d01fc

Co-Authored-By: Vadim Demedes <[email protected]>

vadimdemedes suggested changes Jan 28, 2020

View reviewed changes

Update src/connections/destinations/destination-functions/index.md

e4af128

Co-Authored-By: Vadim Demedes <[email protected]>

kellymtrinh reviewed Jan 28, 2020

View reviewed changes

src/connections/destinations/destination-functions/index.md Outdated Show resolved Hide resolved

kellymtrinh reviewed Jan 28, 2020

View reviewed changes

src/connections/sources/source-function.md Outdated Show resolved Hide resolved

kellymtrinh reviewed Jan 28, 2020

View reviewed changes

src/connections/sources/source-function.md Outdated Show resolved Hide resolved

Andy and others added 3 commits January 28, 2020 11:22

Update src/connections/sources/source-function.md

154ac18

Co-Authored-By: Vadim Demedes <[email protected]>

Update with changes

0a09769

Merge branch 'new-ui' of ssh://github.com/segmentio/segment-docs into…

487bf38

… new-ui

chriso reviewed Jan 28, 2020

View reviewed changes

misteryeo added 2 commits January 28, 2020 13:09

Update with changes

8369b30

Update regarding deploys

c497003

misteryeo requested a review from vadimdemedes January 28, 2020 21:58

sanscontext reviewed Jan 28, 2020

View reviewed changes

src/connections/destinations/destination-functions/index.md Outdated Show resolved Hide resolved

sanscontext and others added 2 commits January 28, 2020 14:57

Fairly extensive formatting and copy edit

8824b5c

Merge branch 'master' into new-ui

e25043e

sanscontext reviewed Jan 29, 2020

View reviewed changes

src/connections/destinations/destination-functions/index.md Outdated Show resolved Hide resolved

src/connections/destinations/destination-functions/index.md Outdated Show resolved Hide resolved

misteryeo added 4 commits January 28, 2020 17:16

Refreshes repository of images

eaac0ac

Cleans up screenshots

e1e1002

Merge branch 'new-ui' of ssh://github.com/segmentio/segment-docs into…

42733ed

… new-ui

Final polish

7745317

vadimdemedes reviewed Jan 29, 2020

View reviewed changes

src/connections/sources/source-functions/index.md Outdated Show resolved Hide resolved

vadimdemedes reviewed Jan 29, 2020

View reviewed changes

src/connections/sources/source-functions/index.md Outdated Show resolved Hide resolved

vadimdemedes suggested changes Jan 29, 2020

View reviewed changes

tysonmote and others added 11 commits January 29, 2020 11:49

Functions: Add documentation for errors and logs

71ea6c0

Functions: Copy edits, remove section about scalability

232eda4

Destination Functions: Fix list formatting

4708643

Update src/connections/destinations/destination-functions/index.md

3cb6fc6

Co-Authored-By: Vadim Demedes <[email protected]>

Update src/connections/destinations/destination-functions/index.md

69c31e4

Co-Authored-By: Vadim Demedes <[email protected]>

Update src/connections/destinations/destination-functions/index.md

de60c94

Co-Authored-By: Vadim Demedes <[email protected]>

Update src/connections/sources/source-functions/index.md

d00d9e8

Co-Authored-By: Vadim Demedes <[email protected]>

Functions: Add error logs screenshots

3205a28

Functions: Reduce PNG file sizes

7766770

Restore old Custom Source/Destination docs, remove redirect

ae400a6

Merge branch 'master' into new-ui

d49ecb8

misteryeo merged commit 8b2c0f5 into master Jan 29, 2020

misteryeo deleted the new-ui branch January 29, 2020 22:02

bot-docsteam added a commit that referenced this pull request Sep 8, 2022

Merge pull request #558 from segmentio/repo-sync

5694195

repo sync

naiba4 mentioned this pull request Jul 8, 2023

[Snyk] Security upgrade semver from 7.3.5 to 7.5.2 naiba4/segment-docs#9

Open

FS-github-snyk mentioned this pull request Sep 19, 2023

[Snyk] Fix for 3 vulnerabilities cowpaths/segmentio-segment-docs#14

Closed

hazemdraosha111 mentioned this pull request Apr 25, 2024

[Snyk] Fix for 15 vulnerabilities hazemdraosha111/segment-docs#25

Open

	let settingValue = settings.settingKey;
	// Retrieve value of a setting `settingKey`
	const settingValue = settings.settingKey;

	async function onRequest(request, settings) {
	function onRequest(request, settings) {

	const requestHeader = request.headers.get('Content-Type')
	const contentType = request.headers.get('Content-Type')

	let settingValue = settings.settingKey;
	// Retrieve value of a setting "settingKey"
	const settingValue = settings.settingKey;

Update Function Docs to reflect new UI #558

Update Function Docs to reflect new UI #558

Uh oh!

Conversation

misteryeo commented Jan 28, 2020

Proposed changes

Related issues (optional)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sanscontext left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!