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.

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

docs: add python, update .net provider docs #1305

Merged
merged 3 commits into from
Apr 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/concepts/syncs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ flagd can connect to one or more sync sources.
The file path sync provider reads and watch the source file for updates(ex: changes and deletions).
It's important to note that most file operations result in multiple file system events.
For production use-cases, a symbolic link is recommended for the watched file, which enables atomic modification.
See the [relevant troubleshooting entry](../../troubleshooting/#extra-duplicate-events-in-file-syncs).
See the [relevant troubleshooting entry](../troubleshooting.md#extra-duplicate-events-in-file-syncs).

```shell
flagd start --uri file:etc/featureflags.json
Expand Down
3 changes: 2 additions & 1 deletion docs/providers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ The following table lists all the available flagd providers.
| :fontawesome-brands-java: [Java](./java.md) | :material-check: | :material-check: |
| :fontawesome-brands-node-js: [Node.JS](./nodejs.md) | :material-check: | :material-check: |
| :simple-php: [PHP](./php.md) | :material-check: | :material-close: |
| :simple-dotnet: [.NET](./dotnet.md) | :material-check: | :material-close: |
| :simple-dotnet: [.NET](./dotnet.md) | :material-check: | :material-check: |
| :simple-python: [Python](./python.md) | :material-check: | :material-close: |
beeme1mr marked this conversation as resolved.
Show resolved Hide resolved
| :material-web: [Web](./web.md) | :material-check: | :material-close: |

For information on implementing a flagd provider, see the specifications for [RPC](../reference/specifications/rpc-providers.md) and [in-process](../reference/specifications/in-process-providers.md) providers.
8 changes: 8 additions & 0 deletions docs/providers/python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Python provider

## Installation

{%
include "https://raw.githubusercontent.com/open-feature/python-sdk-contrib/main/providers/openfeature-provider-flagd/README.md"
start="## Installation"
%}
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ nav:
- 'Node.JS': 'providers/nodejs.md'
- 'PHP': 'providers/php.md'
- '.NET': 'providers/dotnet.md'
- 'Python': 'providers/python.md'
- 'Web': 'providers/web.md'
- 'Reference':
- 'CLI':
Expand Down
Loading