Go bob docs #2139

ctrlaltdylan · 2022-01-27T16:13:17Z

Adds Go Lang documentation that rhymes with the Python and Bash formats.

One main difference is at the language level - Go doesn't raise exceptions like other languages.

I've literally never written Go before, so criticism is more than welcome.

Blockers

There's an error when trying to access pd.Steps in the pipedream-go package. @dylburger 's aware and is making a fix. So the "Passing data between steps" example is in limbo until I can see the step's structure in a live step.

vercel · 2022-01-27T16:13:20Z

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/CdzUD94zemzmuNwQaghPTpCzfLLK
✅ Preview: https://pipedream-docs-redirect-do-not-edit-git-go-af2a6f-pipedreamers.vercel.app

pipedream-docs – ./docs

🔍 Inspect: https://vercel.com/pipedreamers/pipedream-docs/GbVUpAE4NzWrRASWRicHHGd9bPX4
✅ Preview: https://pipedream-docs-git-go-bob-docs-pipedreamers.vercel.app

ctrlaltdylan · 2022-01-27T17:08:38Z

@dylburger by the way, the Bash & Python edits I just made to the v2 main branch will be applied to these Go docs after a merge. It would be much more efficient to switch between pages locally than try reading 2 different pages across different branches.

dylburger · 2022-01-31T05:54:25Z

docs/docs/code/go/README.md


-https://pkg.go.dev/net/http
+::: warning
+Go steps are available in a limited alpha release.


Incorporate the changes you made in the Bash doc in this section, as well. e.g. reference the generic feature like "HTTP responses" instead of $.respond.

docs/docs/code/go/README.md

dylburger · 2022-01-31T06:39:41Z

docs/docs/code/go/README.md

+package main
+
+import (
+  "log"


Any reason to use log over fmt.Println?

Maybe it's my Go ignorance but I couldn't find a function to print out a fatal error, like a console.error equivalent.

The log package was used in few other Go examples I was referencing, I thought perhaps that was why.

docs/docs/code/go/README.md

dylburger · 2022-01-31T06:45:19Z

docs/docs/code/go/README.md

+
+```
+
+The returned error from your Go code will appear in the **logs** area of the results.


Technically it's returned at the top of the workflow execution in inspect mode

docs/docs/code/go/README.md

dylburger

LMK if you have any questions on the comments

…o-bob-docs

ctrlaltdylan · 2022-02-07T20:15:36Z

@dylburger Did you want to do another pass on the review or are you good with a merge to the main bob docs?

dylburger · 2022-02-07T23:55:12Z

@ctrlaltdylan nah if you resolved the comments, I'm good. Are you planning to make these edits post-merge with the rest of the Bash / Python docs?

* 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>

ctrlaltdylan added 2 commits January 27, 2022 11:01

Adding Go examples

4d8b9a7

Adding Go Lang version config var

786f5c0

Merge branch 'docs-new-workflow-builder' into go-bob-docs

40b26da

vercel bot deployed to Preview – pipedream-docs-redirect-do-not-edit January 27, 2022 17:13 View deployment

vercel bot deployed to Preview – pipedream-docs January 27, 2022 17:13 View deployment