Testing / modifying code examples #2133

dylburger · 2022-01-26T22:52:05Z

No description provided.

vercel · 2022-01-26T22:52:08Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

pipedream-docs-redirect-do-not-edit – ./docs

🔍 Inspect: https://vercel.com/pipedreamers/pipedream-docs-redirect-do-not-edit/2KLvwcDBBBsntp4nuPU6LQQjWVYY
✅ Preview: https://pipedream-docs-redirect-do-not-edit-git-dyl-e0368c-pipedreamers.vercel.app

pipedream-docs – ./docs

🔍 Inspect: https://vercel.com/pipedreamers/pipedream-docs/G9eMURYXmAgQZrMYP6SwYrXFakqs
✅ Preview: https://pipedream-docs-git-dylan-code-testing-pipedreamers.vercel.app

docs/docs/.vuepress/config.js

dylburger · 2022-01-26T22:52:53Z

docs/docs/code/nodejs/README.md


 [Read the props reference for the full list of options](/components/api/#props).

-## `async` function declaration


This section still referenced the old function declaration so I modified to discuss components. lmk if you think this can be improved

dylburger · 2022-01-26T22:53:19Z

docs/docs/code/nodejs/README.md



-## `$end`
+## Ending a workflow early


Some references to $end still here, just modifying

dylburger · 2022-01-26T22:53:51Z

docs/docs/code/nodejs/README.md

+export default defineComponent({
  async run({ steps, $ }) {
-    $.flow.exit();
+    return $.flow.exit();


I always forget that using $.flow.exit() requires an explicit return. Not a great DX but you can talk to Giao about this one... we've faced some challenges here.

Oh wow I didn't know that. My other examples are broken then. I thought it was the same behavior as $.end

dylburger · 2022-01-26T22:54:18Z

docs/docs/code/nodejs/auth/README.md

    }
  },
  async run({ steps, $ }) {
-    const web = new WebClient(this.slack.$auths.oauth_access_token)


Changing references from $auths -> $auth. Data is exposed in the singular object

Thanks, good catch

ctrlaltdylan · 2022-01-27T12:20:49Z

docs/docs/code/nodejs/working-with-files/README.md

    const { path, cleanup } = await file();
    await fs.promises.appendFile(path, Buffer.from("hello, world"))
    await cleanup();
-  })


Ah right, legacy from the run

* Changing docs root to prep for docs changes * Committing new vercel.json to handle pathing * Moving to a sub-language navigation and adding Python examples * Adding more python docs about file storage, sending files, etc * Tweaks to python and finishing up bash steps * Basic tmp example for curl * mid edit through the to-do list * Completing review notes * Incorporating dropdown versioning and adding new signifier * Adding fun gradient styling * Playing with a typeface * Removing dead spaces * Fixing mis-configured subsection path * Adding file example * Hack to support internal relative URLs * Good spellchecker * More spell checking * Polish iteration #2.8 * Matching bash format for passing data more closely * Adding a limitation note as well * Adding defineComponent wrapping to main nodejs README and working with files section * Gotta catch'em all ...typos * Adding $.auth and removing checkpoints altogether * Adding $.service.db examples in the state docs * Adding state management docs * Adding 404 checker * Adding spellchecking appeasement & removing loud 404 finder * Dedupe is fine * Docs v2 updates (#2090) Co-authored-by: Dylan J. Sather <dylan.sather@gmail.com> * Adding multiworkflow example * Adding Node.js passing data between steps, route addition to fix URL change, typos * python vs Python * Iteration #5 * Spellchecking * Removing obsolete $.flow.end statement in inspector logs * Testing / modifying code examples (#2133) * Forgot we had the async code doc, as well. * Testing code examples. * $auths -> $auth * Migrating HTTP request examples to components * Correcting file examples * Fixing redundant python ENV example * Adding Dylan's Edits * Adding a more concrete file example to fix spellchecker and make it easier to grok the concept * Correcting two links * Fixing broken links * Fixing misnamed to * Redirect docs-v2 to docs/v2 * Empty commit to trigger v2 docs build on vercel * Moving to (.*) format * newline * docs-v2 to docs/v2 * Go bob docs (#2139) * Adding Go examples * Adding Go Lang version config var * Applying review comments * Wordlist and updating vercel * Missing some words * Modifying redirects Co-authored-by: Dylan Pierce <me@dylanjpierce.com> Co-authored-by: Pravin <pravin@pipedream.com>

* Changing docs root to prep for docs changes * Committing new vercel.json to handle pathing * Moving to a sub-language navigation and adding Python examples * Adding more python docs about file storage, sending files, etc * Tweaks to python and finishing up bash steps * Basic tmp example for curl * mid edit through the to-do list * Completing review notes * Incorporating dropdown versioning and adding new signifier * Adding fun gradient styling * Playing with a typeface * Removing dead spaces * Fixing mis-configured subsection path * Adding file example * Hack to support internal relative URLs * Good spellchecker * More spell checking * Polish iteration #2.8 * Matching bash format for passing data more closely * Adding a limitation note as well * Adding defineComponent wrapping to main nodejs README and working with files section * Gotta catch'em all ...typos * Adding $.auth and removing checkpoints altogether * Adding $.service.db examples in the state docs * Adding state management docs * Adding 404 checker * Adding spellchecking appeasement & removing loud 404 finder * Dedupe is fine * Docs v2 updates (#2090) Co-authored-by: Dylan J. Sather <dylan.sather@gmail.com> * Adding multiworkflow example * Adding Node.js passing data between steps, route addition to fix URL change, typos * python vs Python * Iteration #5 * Spellchecking * Removing obsolete $.flow.end statement in inspector logs * Testing / modifying code examples (#2133) * Forgot we had the async code doc, as well. * Testing code examples. * $auths -> $auth * Migrating HTTP request examples to components * Correcting file examples * Fixing redundant python ENV example * Adding Dylan's Edits * Adding a more concrete file example to fix spellchecker and make it easier to grok the concept * Correcting two links * Fixing broken links * Fixing misnamed to * Redirect docs-v2 to docs/v2 * Empty commit to trigger v2 docs build on vercel * Moving to (.*) format * newline * docs-v2 to docs/v2 * Go bob docs (#2139) * Adding Go examples * Adding Go Lang version config var * Applying review comments * Wordlist and updating vercel * Missing some words * Adding docs naked * Newline Co-authored-by: Dylan J. Sather <dylan.sather@gmail.com> Co-authored-by: Pravin <pravin@pipedream.com>

* Changing docs root to prep for docs changes * Committing new vercel.json to handle pathing * Moving to a sub-language navigation and adding Python examples * Adding more python docs about file storage, sending files, etc * Tweaks to python and finishing up bash steps * Basic tmp example for curl * mid edit through the to-do list * Completing review notes * Incorporating dropdown versioning and adding new signifier * Adding fun gradient styling * Playing with a typeface * Removing dead spaces * Fixing mis-configured subsection path * Adding file example * Hack to support internal relative URLs * Good spellchecker * More spell checking * Polish iteration #2.8 * Matching bash format for passing data more closely * Adding a limitation note as well * Adding defineComponent wrapping to main nodejs README and working with files section * Gotta catch'em all ...typos * Adding $.auth and removing checkpoints altogether * Adding $.service.db examples in the state docs * Adding state management docs * Adding 404 checker * Adding spellchecking appeasement & removing loud 404 finder * Dedupe is fine * Docs v2 updates (#2090) Co-authored-by: Dylan J. Sather <dylan.sather@gmail.com> * Adding multiworkflow example * Adding Node.js passing data between steps, route addition to fix URL change, typos * python vs Python * Iteration #5 * Spellchecking * Removing obsolete $.flow.end statement in inspector logs * Testing / modifying code examples (#2133) * Forgot we had the async code doc, as well. * Testing code examples. * $auths -> $auth * Migrating HTTP request examples to components * Correcting file examples * Fixing redundant python ENV example * Adding Dylan's Edits * Adding a more concrete file example to fix spellchecker and make it easier to grok the concept * Correcting two links * Fixing broken links * Fixing misnamed to * Basic outline of the migration guide * WIP - more content * Filling out skeleton more * Accidental commits * Adding http response section * Spellchecking * Simplifying * More editing * Edits * Run through #3 * Adding slack example * Spellchecking * Fixing internal title link scrolling * Adding a few more images and fixing internal links * Adding Pravins updates * Moving migration guide to child nav and adding blurb for v2 only users * Adding testing events reference * Bringing in the video as an embed * Dylans edits v3 * Adding demo poster * Adding Pravins latest edits, fixing youtube Co-authored-by: Dylan J. Sather <dylan.sather@gmail.com> Co-authored-by: Pravin <pravin@pipedream.com>

* Changing docs root to prep for docs changes * Committing new vercel.json to handle pathing * Moving to a sub-language navigation and adding Python examples * Adding more python docs about file storage, sending files, etc * Tweaks to python and finishing up bash steps * Basic tmp example for curl * mid edit through the to-do list * Completing review notes * Incorporating dropdown versioning and adding new signifier * Adding fun gradient styling * Playing with a typeface * Removing dead spaces * Fixing mis-configured subsection path * Adding file example * Hack to support internal relative URLs * Good spellchecker * More spell checking * Polish iteration #2.8 * Matching bash format for passing data more closely * Adding a limitation note as well * Adding defineComponent wrapping to main nodejs README and working with files section * Gotta catch'em all ...typos * Adding $.auth and removing checkpoints altogether * Adding $.service.db examples in the state docs * Adding state management docs * Adding 404 checker * Adding spellchecking appeasement & removing loud 404 finder * Dedupe is fine * Docs v2 updates (#2090) Co-authored-by: Dylan J. Sather <dylan.sather@gmail.com> * Adding multiworkflow example * Adding Node.js passing data between steps, route addition to fix URL change, typos * python vs Python * Iteration #5 * Spellchecking * Removing obsolete $.flow.end statement in inspector logs * Testing / modifying code examples (#2133) * Forgot we had the async code doc, as well. * Testing code examples. * $auths -> $auth * Migrating HTTP request examples to components * Correcting file examples * Fixing redundant python ENV example * Adding Dylan's Edits * Adding a more concrete file example to fix spellchecker and make it easier to grok the concept * Adding navgrid to v1 vuepress docs [WIP] * Moving navgrid component and starting to separate concepts from the main quickstart * Moving docs into a different hierarchy * Guides concept, splitting out individual guides from the main READMEs * linting * Adding dist dir * Test * One more try * Modifying assets path * Reintroduce the base config * Reverting assets change * Fixing alignment of concepts grid * Fix auto headers on quickstart * Fixing display block of concepts * Adding footer links & better logos for languages * Reverting concepts subdir and adding better layout * Adding account settings and troubleshooting sections * Sidebar config update * Adidng component icon too * Merge branch 'master' into add-navgrid-to-vuepress1 * Grammar fix and more specific fence * Why does VScode hate newlines on vercel.json? * Fixing incorrect sidebar path * Removing redundant base path config in themeConfig * Attempting to fix asset pathing * Replacing $.service.db with this.store docs * Updating stores docs * Adding more specific JSON serailization examples * Fixing a few typos * Another round of edits * Nav fixes * Using new data_store term * Reverting the name change for now * Removing SDK * Replacing images * Removing inferred_body_type which is removed * Moving /docs/triggers * Updated screenshots * Fixing actions update screenshot and description * Removing problem entry * Fixing 404 * Fixing sidebar and adding separate sections * Fixing v-pre key * Adding getting started to top left nav * Fix navgrid overflow on mobile * Removing old commented out docs * Better tmp file size messaging * Removing Guidelinks experiment * Docs nav change out * Don't add overview route * Nav swaps * Fixing SVG path * Fixing merge conflict * Empty commit to trigger v2 docs build on vercel * Removing dead comma * Removing redundant package-lock.json * Removing broken rule * Using cloudinary for the icon * Reorder side nav * Renaming quickstart & adding primary color not button * gco q * Updating data store intro sentence * Splitting the nav * Dylan's edits * Fixing styles too * Fixing sidebar duplicate links and unnecessary dropdowns * More sidebar massaging * Removing dupe workflow links in code * Fixing missing navbar in the sidebar in mobile * Adding `await` to get / set calls to future-proof a potential async implementation * Adding missing pages, moving cold starts out of reference and back under workflows * Adding missing events inspect docs Co-authored-by: Dylan Pierce <me@dylanjpierce.com> Co-authored-by: Pravin <pravin@pipedream.com> Co-authored-by: Danny Roosevelt <danny@pipedream.com>

dylburger added 5 commits January 26, 2022 14:05

Forgot we had the async code doc, as well.

0759115

Testing code examples.

0127d31

$auths -> $auth

c9ab7f2

Migrating HTTP request examples to components

53db31d

Correcting file examples

489a290

dylburger commented Jan 26, 2022

View reviewed changes

docs/docs/.vuepress/config.js Show resolved Hide resolved

dylburger commented Jan 26, 2022

View reviewed changes

ctrlaltdylan reviewed Jan 27, 2022

View reviewed changes

ctrlaltdylan approved these changes Jan 27, 2022

View reviewed changes

ctrlaltdylan merged commit 885eb7a into docs-new-workflow-builder Jan 27, 2022

ctrlaltdylan deleted the dylan-code-testing branch January 27, 2022 13:59

ctrlaltdylan mentioned this pull request Mar 18, 2022

docs stores concept #2457

Closed

ctrlaltdylan mentioned this pull request Mar 28, 2022

docs 2.1 #2504

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Testing / modifying code examples #2133

Testing / modifying code examples #2133

Uh oh!

dylburger commented Jan 26, 2022

Uh oh!

vercel bot commented Jan 26, 2022 •

edited

Loading

Uh oh!

Uh oh!

dylburger Jan 26, 2022

Uh oh!

dylburger Jan 26, 2022

Uh oh!

dylburger Jan 26, 2022

Uh oh!

ctrlaltdylan Jan 27, 2022

Uh oh!

dylburger Jan 26, 2022

Uh oh!

ctrlaltdylan Jan 27, 2022

Uh oh!

ctrlaltdylan Jan 27, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		[Read the props reference for the full list of options](/components/api/#props).

		## `async` function declaration

Testing / modifying code examples #2133

Testing / modifying code examples #2133

Uh oh!

Conversation

dylburger commented Jan 26, 2022

Uh oh!

vercel bot commented Jan 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

pipedream-docs-redirect-do-not-edit – ./docs

pipedream-docs – ./docs

Uh oh!

Uh oh!

dylburger Jan 26, 2022

Choose a reason for hiding this comment

Uh oh!

dylburger Jan 26, 2022

Choose a reason for hiding this comment

Uh oh!

dylburger Jan 26, 2022

Choose a reason for hiding this comment

Uh oh!

ctrlaltdylan Jan 27, 2022

Choose a reason for hiding this comment

Uh oh!

dylburger Jan 26, 2022

Choose a reason for hiding this comment

Uh oh!

ctrlaltdylan Jan 27, 2022

Choose a reason for hiding this comment

Uh oh!

ctrlaltdylan Jan 27, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vercel bot commented Jan 26, 2022 •

edited

Loading