add provider docs

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
open-feature · Nov 21, 2023 · a4fb65b · a4fb65b
1 parent 2aa68fa
commit a4fb65b
Show file tree

Hide file tree

Showing 12 changed files with 358 additions and 246 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,2 @@
+FROM squidfunk/mkdocs-material
+RUN pip install mkdocs-include-markdown-plugin
diff --git a/Makefile b/Makefile
@@ -122,4 +122,5 @@ generate-proto-docs: pull-schemas-submodule
 
 .PHONY: run-web-docs
 run-web-docs: generate-docs generate-proto-docs
-	docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
+	docker build -t squidfunk/mkdocs-material . \
+	&& docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
diff --git a/docs/installation.md b/docs/installation.md
@@ -52,29 +52,13 @@ go install github.com/open-feature/flagd/flagd@latest
 
 ---
 
-## In-Process
+## flagd Providers for OpenFeature
 
-### :fontawesome-brands-golang: Go in-process provider
+Leverage flagd in your application using [OpenFeature](https://openfeature.dev/) and a flagd [provider](https://openfeature.dev/docs/reference/concepts/provider).
+Use the table below to see what provides are available.
 
-[flagd-in-process/pkg](https://pkg.go.dev/github.com/open-feature/go-sdk-contrib/providers/flagd-in-process/pkg)
-
-```shell
-go get github.com/open-feature/go-sdk-contrib/providers/flagd-in-process/pkg@latest
-```
-
-### :fontawesome-brands-java: Java in-process provider
-
-#### Maven
-
-```xml
-<dependency>
-  <groupId>dev.openfeature.contrib.providers</groupId>
-  <artifactId>flagd</artifactId>
-</dependency>
-```
-
-#### Gradle
-
-```gradle
-implementation 'dev.openfeature.contrib.providers:flagd'
-```
+| Technology                                               | RPC              | in-process       |
+| -------------------------------------------------------- | ---------------- | ---------------- |
+| :fontawesome-brands-golang: [Go](./providers/go.md) | :material-check: | :material-check: |
+| :fontawesome-brands-java: [Java](./providers/java.md) | :material-check: | :material-check: |
+| :fontawesome-brands-node-js: [Node.JS](./providers/nodejs.md) | :material-check: | :material-check: |
diff --git a/docs/providers/dotnet.md b/docs/providers/dotnet.md
@@ -0,0 +1,9 @@
+
+# .NET provider
+
+## Installation
+
+{%
+  include "https://raw.githubusercontent.com/open-feature/dotnet-sdk-contrib/main/src/OpenFeature.Contrib.Providers.Flagd/README.md"
+  start="## Install dependencies"
+%}
diff --git a/docs/providers/go.md b/docs/providers/go.md
@@ -0,0 +1,13 @@
+
+# Go provider
+
+{%
+  include "https://raw.githubusercontent.com/open-feature/go-sdk-contrib/main/providers/flagd/README.md"
+  start="## Setup"
+  end="## License"
+%}
+
+{%
+  include "https://raw.githubusercontent.com/open-feature/go-sdk-contrib/main/providers/flagd-in-process/README.md"
+  end="## License"
+%}
diff --git a/docs/providers/java.md b/docs/providers/java.md
@@ -0,0 +1,9 @@
+
+# Java provider
+
+## Installation
+
+{%
+  include "https://raw.githubusercontent.com/open-feature/java-sdk-contrib/main/providers/flagd/README.md"
+  start="## Installation"
+%}
diff --git a/docs/providers/nodejs.md b/docs/providers/nodejs.md
@@ -0,0 +1,10 @@
+
+# Node.js provider
+
+## Installation
+
+{%
+  include "https://raw.githubusercontent.com/open-feature/js-sdk-contrib/main/libs/providers/flagd/README.md"
+  start="## Installation"
+  end="## Building"
+%}
diff --git a/docs/providers/php.md b/docs/providers/php.md
@@ -0,0 +1,9 @@
+
+# PHP provider
+
+## Installation
+
+{%
+  include "https://raw.githubusercontent.com/open-feature/php-sdk-contrib/main/providers/Flagd/README.md"
+  start="## Installation"
+%}
diff --git a/docs/providers/web.md b/docs/providers/web.md
@@ -0,0 +1,9 @@
+
+# Web provider
+
+## Installation
+
+{%
+  include "https://github.com/open-feature/js-sdk-contrib/blob/main/libs/providers/flagd-web/README.md"
+  start="## Installation"
+%}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -45,7 +45,8 @@ markdown_extensions:
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.inlinehilite
-  - pymdownx.snippets
+  - pymdownx.snippets:
+      url_download: true
   - admonition
   - pymdownx.details
   - pymdownx.superfences:
@@ -68,6 +69,13 @@ nav:
     - 'Feature Flagging': 'concepts/feature-flagging.md'
     - 'Syncs': 'concepts/syncs.md'
   - 'Architecture': 'architecture.md'
+  - 'Providers':
+    - 'Go': 'providers/go.md'
+    - 'Java': 'providers/java.md'
+    - 'Node.JS': 'providers/nodejs.md'
+    - 'PHP': 'providers/php.md'
+    - '.NET': 'providers/dotnet.md'
+    - 'Web': 'providers/web.md'
   - 'Reference':
     - 'CLI':
       - 'Overview': 'reference/flagd-cli/flagd.md'
@@ -99,4 +107,6 @@ nav:
   - 'Troubleshooting': 'troubleshooting.md'
 plugins:
   - social
-  - search
+  - search
+  # https://github.com/mondeja/mkdocs-include-markdown-plugin
+  - include-markdown
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,6 +14,7 @@ pymdown-extensions = "^10.1"
 fontawesome-markdown = "^0.2.6"
 pillow = "^10.0.0"
 cairosvg = "^2.7.1"
+mkdocs-include-markdown-plugin = "^6.0.4"
 
 
 [build-system]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		FROM squidfunk/mkdocs-material
		RUN pip install mkdocs-include-markdown-plugin