open-feature / docs.openfeature.dev

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

feat: Initial version of Java getting started page #184

Closed Kavindu-Dodan closed 1 year ago

Kavindu-Dodan commented 1 year ago

This PR

PR introduces getting started documentation for OpenFeature Java SDK

How to test

Given that this is a getting started guide, you should be able to validate content by following the given steps in it.

netlify[bot] commented 1 year ago

Deploy Preview for lucky-creponne-baf9b3 ready!

Name Link
Latest commit dfdad93c0fdc8b542395147273cfe489b78d35d8
Latest deploy log https://app.netlify.com/sites/lucky-creponne-baf9b3/deploys/637e728b5402d7000979c514
Deploy Preview https://deploy-preview-184--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

Direct link to the walk-through: https://deploy-preview-184--lucky-creponne-baf9b3.netlify.app/docs/getting-started/java/

Kavindu-Dodan commented 1 year ago

I think it may be worth considering moving the FlagD dependency and code sections to after step 4. That would allow for the opportunity to explain what a provider is and that FlagD is just one of many options.

I have addressed this in the latest changeset

toddbaert commented 1 year ago

@Kavindu-Dodan I think this is really good, I left a few minor comments. The biggest one I think is that we should inject an OpenFeature client, not the API. What do you think about that?