examples

examples copied to clipboard

First drop of of NodeJS examples for IBM Cloud Functions (ICF) with background info. seeking to address issue https://github.com/nodejs/examples/issues/15.

Please feel free to assign the issue to me, as well as this PR.

@mrutkows thanks. Will try to review next week.

@mrutkows thanks. Will try to review next week.

Thanks @mhdawson, this is a WIP (draft) at the moment and hope to complete shortly...

@mrutkows thanks for the update, let me know once its complete, I'll hold of reviewing until then.

@mhdawson After some delay to track down an issue... I believe it is now ready for a review. Please note that I updated the top-level README to alphabetize the listed technpologies and move gcr to what I believe is the correct category.

@mhdawson Thanks for the find... changed the license headers to vanilla Apache 2 boilerplate for the two markdown files.

Thanks @rodion-arr for your completeness in reviewing.

Retargeted to main, will check this as soon as I can - have been slammed with some other priorities recently ❤️

@bnb I need (irony)

inline html (only) to allow for large output to be hidden unless the developer cares to compare their output to a sample. Otherwise, we want to hide it (as a dropdown) to not clutter the actual CLI commands and make the README appear overly long and complicated.

@bnb if we can update the linter to allow

so the README looks clean and if I add subdirs. (1 per each unique example (.js, and .json if applicable) is that enough?

Functional .js snippets and supporting .json now in separate subdirs (1 per unique example).

@bnb @mhdawson Passes new linter; addressed examples layout. Please review when able.

One question about path for one file, otherwise looks good to me and I think you've addressed what @bnb was looking for in terms of changes. @bnb what do you think?

Please note that the README instructs still asks the developer to create the functional files wherever they happen to be in their terminal...

If the expectation (not clear to me) is that the developer would clone this entire repo., then one could provide directory relative instructions, but had assumed developers would "pick and choose" which tech/examples they would try and not require them to clone the entire repo. which could get quite large given the scope being planned

One question about path for one file, otherwise looks good to me and I think you've addressed what @bnb was looking for in terms of changes. @bnb what do you think?

drag/drop error in vscode... good catch (fixed)

@bnb when you get a moment, let's discuss this. If there is anything else needed, I can do so, otherwise, it should be good to go? Thanks!!! ❤️

@joesepi was planning on taking a look next week when I'm back from OOO 👍🏻

@joesepi it looks like a lot of the feedback I've given previously in the PR (specifically in the README) hasn't been addressed 😬

So, being totally upfront: the content in the README is really good and too comprehensive/tutorial-esque for this repository.

My recommendation here would be to strip out the README here and put it into an article that we publish once this PR is merged and replace the current README that's more along the lines of a typical OSS project REAMDE that you'd expect to see on GitHub / npm. This is an example specific to IBM Cloud Functions, and here are a few generic examples of the style I'm talking about.

More than happy to help how I can on this - pairing, advice, etc.

Okay. That makes sense. I'll look at this as soon as I can and help get it over the finish line. I like the idea of a blog post too.