Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] flagd provider docs #334

Closed
beeme1mr opened this issue Jan 27, 2023 · 1 comment · Fixed by #413
Closed

[DOC] flagd provider docs #334

beeme1mr opened this issue Jan 27, 2023 · 1 comment · Fixed by #413
Assignees
@skyerus
Labels
documentation Improvements or additions to documentation Needs Triage This issue needs to be investigated by a maintainer

Comments

@beeme1mr
Copy link
Member

Change in the documentation

Create documentation that explains how a new provider can be developed. This can be referenced by new and existing flagd providers to ensure a consistent experience across technologies.

Areas to include:

  • Responsibilities of a flagd provider
  • Where to find the protobuf definitions
  • How to generate a client library using Buf
  • Caching recommendations
  • Recommended environments variables
  • How to handle failure conditions
  • Design considerations
@beeme1mr beeme1mr added documentation Improvements or additions to documentation Needs Triage This issue needs to be investigated by a maintainer labels Jan 27, 2023
@toddbaert
Copy link
Member

toddbaert commented Jan 27, 2023 •
edited
Loading

I would also add a link to the general provider recommendations/FAQ: https://docs.openfeature.dev/docs/reference/concepts/provider#faq
https://docs.openfeature.dev/docs/reference/concepts/provider/#checklist

Does Recommended environments variables mean standard ENV vars and config overriding?

Otherwise, this sounds good.

@beeme1mr beeme1mr moved this from Backlog to Todo in ☁ Cloud Native Jan 30, 2023
@skyerus skyerus self-assigned this Feb 13, 2023
@skyerus skyerus mentioned this issue Feb 15, 2023
Merged
skyerus added a commit that referenced this issue Feb 16, 2023
@skyerus @beeme1mr
docs: documentation for creating a provider (#413)
d0c099d 
<!-- Please use this template for your pull request. -->
<!-- Please use the sections that you need and delete other sections -->

## This PR
<!-- add the description of the PR here -->

- Documents how to create a flagd provider.

### Related Issues
<!-- add here the GitHub issue that this PR resolves if applicable -->

Fixes #334 

### Notes
<!-- any additional notes for this PR -->

### Follow-up Tasks
<!-- anything that is related to this PR but not done here should be
noted under this section -->
<!-- if there is a need for a new issue, please link it here -->

### How to test
<!-- if applicable, add testing instructions under this section -->

---------

Signed-off-by: Skye Gill <gill.skye95@gmail.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
@github-project-automation github-project-automation bot moved this from Todo to Done in ☁ Cloud Native Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@skyerus skyerus

Labels
documentation Improvements or additions to documentation Needs Triage This issue needs to be investigated by a maintainer
Projects
No open projects
☁ Cloud Native
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: documentation for creating a provider skyerus/flagd
3 participants
@beeme1mr @toddbaert @skyerus