mirrors/sablier
1
0
Fork 0
mirror of https://github.com/sablierapp/sablier.git synced 2025-12-26 23:21:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add multiversioned documentation (#344)

Browse Source 
Documentation is now published on the `gh-pages` branch.

The branch will have a folder `docs` containing the following structure:
- `./docs` the copy from the `main` docs, but only used for the `index.html` page to do the multi-version routing.
- `./docs/main` the copy from the `main` branch docs folder
- `./docs/beta` the copy from the `beta` branch docs folder

Closes #332
This commit is contained in:
Alexis Couvreur
2024-07-03 14:56:59 -04:00
parent 0a88d3d330
commit fbb6e38d53
16 changed files with 128 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/plugins/apacheapisix.md
View File

@@ -4,11 +4,11 @@ The Apache APISIX Plugin is a WASM Plugin written with the Proxy Wasm SDK.
## Provider compatibility grid
| Provider | Dynamic | Blocking |
|-----------------------------------------|:-------:|:--------:|
| [Docker](/providers/docker) | ✅ | ✅ |
| [Docker Swarm](/providers/docker_swarm) | ❓ | ❓ |
| [Kubernetes](/providers/kubernetes) | ❓ | ❓ |
| Provider | Dynamic | Blocking |
|----------------------------------------|:-------:|:--------:|
| [Docker](../providers/docker) | ✅ | ✅ |
| [Docker Swarm](../providers/docker_swarm) | ❓ | ❓ |
| [Kubernetes](../providers/kubernetes) | ❓ | ❓ |
## Install the plugin to Apache APISIX

6
docs/plugins/caddy.md
View File

@@ -6,9 +6,9 @@ Caddy Sablier Plugin.
| Provider | Dynamic | Blocking |
| --------------------------------------- | :-----: | :------: |
| [Docker](/providers/docker) | ✅ | ✅ |
| [Docker Swarm](/providers/docker_swarm) | ✅ | ✅ |
| [Kubernetes](/providers/kubernetes) | ❌ | ❌ |
| [Docker](../providers/docker) | ✅ | ✅ |
| [Docker Swarm](../providers/docker_swarm) | ✅ | ✅ |
| [Kubernetes](../providers/kubernetes) | ❌ | ❌ |
## Install the plugin to Caddy

6
docs/plugins/envoy.md
View File

@@ -6,9 +6,9 @@ The Envoy Plugin is a WASM Plugin written with the Proxy Wasm SDK.
| Provider | Dynamic | Blocking |
|-----------------------------------------|:-------:|:--------:|
| [Docker](/providers/docker) | ✅ | ✅ |
| [Docker Swarm](/providers/docker_swarm) | ❓ | ❓ |
| [Kubernetes](/providers/kubernetes) | ❓ | ❓ |
| [Docker](../providers/docker) | ✅ | ✅ |
| [Docker Swarm](../providers/docker_swarm) | ❓ | ❓ |
| [Kubernetes](../providers/kubernetes) | ❓ | ❓ |
## Configuration

6
docs/plugins/istio.md
View File

@@ -6,9 +6,9 @@ The Istio Plugin is a WASM Plugin written with the Proxy Wasm SDK.
| Provider | Dynamic | Blocking |
|-----------------------------------------|:-------:|:--------:|
| [Docker](/providers/docker) | ❌ | ❌ |
| [Docker Swarm](/providers/docker_swarm) | ❌ | ❌ |
| [Kubernetes](/providers/kubernetes) | ✅ | ✅ |
| [Docker](../providers/docker) | ❌ | ❌ |
| [Docker Swarm](../providers/docker_swarm) | ❌ | ❌ |
| [Kubernetes](../providers/kubernetes) | ✅ | ✅ |
## Configuration

6
docs/plugins/nginx.md
View File

@@ -6,9 +6,9 @@ The Nginx Sablier Plugin is a javascript file that runs through the NJS Module.
| Provider | Dynamic | Blocking |
| --------------------------------------- | :-----: | :------: |
| [Docker](/providers/docker) | ✅ | ✅ |
| [Docker Swarm](/providers/docker_swarm) | ✅ | ✅ |
| [Kubernetes](/providers/kubernetes) | ❌ | ❌ |
| [Docker](../providers/docker) | ✅ | ✅ |
| [Docker Swarm](../providers/docker_swarm) | ✅ | ✅ |
| [Kubernetes](../providers/kubernetes) | ❌ | ❌ |
## Install the plugin to NGINX

6
docs/plugins/nginx_proxywasm.md
View File

@@ -6,9 +6,9 @@ The Nginx Plugin is a WASM Plugin written with the Proxy Wasm SDK.
| Provider | Dynamic | Blocking |
|-----------------------------------------|:-------:|:--------:|
| [Docker](/providers/docker) | ✅ | ✅ |
| [Docker Swarm](/providers/docker_swarm) | ❓ | ❓ |
| [Kubernetes](/providers/kubernetes) | ❓ | ❓ |
| [Docker](../providers/docker) | ✅ | ✅ |
| [Docker Swarm](../providers/docker_swarm) | ❓ | ❓ |
| [Kubernetes](../providers/kubernetes) | ❓ | ❓ |
# Install ngx_wasm_module

16
docs/plugins/overview.md
View File

@@ -14,14 +14,14 @@ It leverages the API calls to plugin integration to catch in-flight requests to
| Reverse Proxy | Docker | Docker Swarm mode | Kubernetes |
|-------------------------------------------------|:------:|:-----------------:|:----------:|
| [Apache APISIX](/plugins/apacheapisix) | ✅ | ✅ | ✅ |
| [Caddy](/plugins/caddy) | ✅ | ✅ | ❌ |
| [Envoy](/plugins/envoy) | ✅ | ❓ | ❓ |
| [Istio](plugins/istio) | ❌ | ❌ | ⚠️ |
| [Nginx (NJS Module)](/plugins/nginx_njs) | ✅ | ✅ | ✅ |
| [Nginx (WASM Module)](/plugins/nginx_proxywasm) | ✅ | ❓ | ❓ |
| [Traefik](/plugins/traefik) | ✅ | ✅ | ✅ |
| [ProxyWasm](/plugins/proxywasm) | ✅ | ✅ | ✅ |
| [Apache APISIX](apacheapisix) | ✅ | ✅ | ✅ |
| [Caddy](caddy) | ✅ | ✅ | ❌ |
| [Envoy](envoy) | ✅ | ❓ | ❓ |
| [Istio](istio) | ❌ | ❌ | ⚠️ |
| [Nginx (NJS Module)](nginx_njs) | ✅ | ✅ | ✅ |
| [Nginx (WASM Module)](nginx_proxywasm) | ✅ | ❓ | ❓ |
| [Traefik](traefik) | ✅ | ✅ | ✅ |
| [ProxyWasm](proxywasm) | ✅ | ✅ | ✅ |
> ✅ **Fully compatible**
>

6
docs/plugins/traefik.md
View File

@@ -6,9 +6,9 @@ The [Traefik Sablier Plugin](https://plugins.traefik.io/plugins/633b4658a4caa9dd
| Provider | Dynamic | Blocking |
| --------------------------------------- | :-----: | :-----------------------------------------------------: |
| [Docker](/providers/docker) | ✅ | ✅ |
| [Docker Swarm](/providers/docker_swarm) | ✅ | ✅ |
| [Kubernetes](/providers/kubernetes) | ✅ | ✅ |
| [Docker](../providers/docker) | ✅ | ✅ |
| [Docker Swarm](../providers/docker_swarm) | ✅ | ✅ |
| [Kubernetes](../providers/kubernetes) | ✅ | ✅ |
## Prerequisites