From 90c0be4a64ff3d19420ecdf51769bfc58c86ae60 Mon Sep 17 00:00:00 2001 From: Michael Beemer Date: Tue, 30 Apr 2024 12:17:30 -0400 Subject: [PATCH] docs: add python, update .net provider docs (#1305) ## This PR - fixes an invalid link - adds python provider page - update .NET provider to include in-process --------- Signed-off-by: Michael Beemer --- docs/concepts/syncs.md | 2 +- docs/providers/index.md | 3 ++- docs/providers/python.md | 8 ++++++++ mkdocs.yml | 1 + 4 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 docs/providers/python.md diff --git a/docs/concepts/syncs.md b/docs/concepts/syncs.md index 572b7ec88..612ff7441 100644 --- a/docs/concepts/syncs.md +++ b/docs/concepts/syncs.md @@ -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 diff --git a/docs/providers/index.md b/docs/providers/index.md index 8170a2b28..9851427a0 100644 --- a/docs/providers/index.md +++ b/docs/providers/index.md @@ -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: | | :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. \ No newline at end of file diff --git a/docs/providers/python.md b/docs/providers/python.md new file mode 100644 index 000000000..2b98d7acc --- /dev/null +++ b/docs/providers/python.md @@ -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" +%} diff --git a/mkdocs.yml b/mkdocs.yml index bdf7ee729..9e38210eb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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':