open-feature / open-feature/openfeature.dev
Document the bound domain in provider initialization and domain-scoped providers
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 65
- Forks
- 117
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 41
Description
The spec now supplies the bound domain to a provider's initialize function, and adds an opt-in domain-scoped provider declaration that the API enforces by binding such a provider to at most one domain. The conceptual docs should cover this so provider authors and users understand it.
What needs to happen
- Document that
initializecan receive the bounddomain, and when a provider would use it (e.g. scoping a persistent cache) - Document the
domain-scopedprovider concept: what declaring it means, and that the API binds such a provider to at most onedomain - Fit this into the existing provider/domain and provider-lifecycle docs rather than a standalone page
Related
- #1387 (provider lifecycle guidance), #119 (init/shutdown docs)
Links
- Parent issue: https://github.com/open-feature/spec/issues/403
- Spec sections: 1.1 Flag evaluation, 2.4 Initialization
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing provider/domain and provider-lifecycle documentation referenced in the issue, using related issues #1387 and #119 for context. Document that initialize can receive the bound domain, when it is useful, and what declaring a domain-scoped provider means. Done when the API's one-domain binding rule and both provider concepts are covered in the existing documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 74/100