search

open-feature / docs.openfeature.dev

OpenFeature Documentation
https://openfeature.dev
Creative Commons Attribution 4.0 International
6 stars 19 forks source link

Add initial node getting started doc #182

Closed beeme1mr closed 1 year ago

beeme1mr commented 1 year ago

This PR

Signed-off-by: Michael Beemer beeme1mr@users.noreply.github.com

netlify[bot] commented 1 year ago

Deploy Preview for lucky-creponne-baf9b3 ready!

Name Link
Latest commit c8caece68bb530da5e18bf26e93d813653bb529a
Latest deploy log https://app.netlify.com/sites/lucky-creponne-baf9b3/deploys/637e715e617f2300098f47f2
Deploy Preview https://deploy-preview-182--lucky-creponne-baf9b3.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

beeme1mr commented 1 year ago

Here's a direct link to the doc:

https://deploy-preview-182--lucky-creponne-baf9b3.netlify.app/docs/getting-started/node/

moredip commented 1 year ago

@beeme1mr I’m late in getting my feedback in, but I was wondering how you’d feel about removing the typescript-specific stuff from the tutorial. The concern is that if someone doesn’t know anything about TS they might read this and think that they have to use TS to use the JS SDK. Given that the code samples aren’t really using types anyway, it seems like it would just remove a bit of extra cognitive load if the tutorial skipped references to things like tsc, ts-node, @types/express, and so on.

toddbaert commented 1 year ago

@beeme1mr I’m late in getting my feedback in, but I was wondering how you’d feel about removing the typescript-specific stuff from the tutorial. The concern is that if someone doesn’t know anything about TS they might read this and think that they have to use TS to use the JS SDK. Given that the code samples aren’t really using types anyway, it seems like it would just remove a bit of extra cognitive load if the tutorial skipped references to things like tsc, ts-node, @types/express, and so on.

@moredip

I see your point, and also as somebody who wrote almost exclusively JS/TS for a chunk of time, knowing TS has first-class support immediately makes a project more attractive.

I'm working on extracting some of the common language/structure between this and the Java tutorial anyway. When I'm doing that I could also add a pure-JS version. What do you think of that? Is that overkill? Should we just white the JS version and mention we support TS?

beeme1mr commented 1 year ago

I think it might be worth having both versions. They could live in the same doc and you could toggle between the two using a tab group. I could add that next week.

toddbaert commented 1 year ago

I think it might be worth having both versions. They could live in the same doc and you could toggle between the two using a tab group. I could add that next week.

I like that solution.