docs: updated all versions in documentation

sablierapp · Nov 10, 2024 · 2976392 · 2976392
1 parent bb87e0d
commit 2976392
Show file tree

Hide file tree

Showing 12 changed files with 21 additions and 124 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -4,7 +4,6 @@
 - [Configuration](/configuration)
 - [Strategies](/strategies)
 - [Themes](/themes)
-- [FAQ](/faq)
 - [Versioning](/versioning)
 - **Providers**
   - [Overview](/providers/overview)

diff --git a/docs/api/README.md b/docs/api/README.md
diff --git a/docs/assets/img/favicon.ico b/docs/assets/img/favicon.ico
diff --git a/docs/faq.md b/docs/faq.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -36,7 +36,7 @@ Suppose this is your initial setup with Caddy. You have your reverse proxy with
 ```yaml
 services:
   proxy:
-    image: caddy:2.6.4
+    image: caddy:2.8.4
     ports:
       - "8080:80"
     volumes:
@@ -68,7 +68,7 @@ Add the Sablier container in the `docker-compose.yaml` file.
 ```yaml
 services:
   proxy:
-    image: caddy:2.6.4
+    image: caddy:2.8.4
     ports:
       - "8080:80"
     volumes:
@@ -93,17 +93,17 @@ Because Caddy does not provide any runtime evaluation for the plugins, we need t
 I'll use the provided Dockerfile to build the custom Caddy image.
 
 ```bash
-docker build https://github.com/sablierapp/sablier.git#v1.4.0-beta.3:plugins/caddy 
-  --build-arg=CADDY_VERSION=2.6.4
-  -t caddy:2.6.4-with-sablier
+docker build https://github.com/sablierapp/sablier.git#v1.8.1:plugins/caddy 
+  --build-arg=CADDY_VERSION=2.8.4
+  -t caddy:2.8.4-with-sablier
 ```
 
-Then change the image to from `caddy:2.6.4` to `caddy:2.6.4-with-sablier`
+Then change the image to from `caddy:2.8.4` to `caddy:2.8.4-with-sablier`
 
 ```yaml
 services:
   proxy:
-    image: caddy:2.6.4-with-sablier
+    image: caddy:2.8.4-with-sablier
     ports:
       - "8080:80"
     volumes:
@@ -123,7 +123,7 @@ services:
 
 ### 4. Configure Caddy to use the Sablier Caddy Plugin on the `whoami` service
 
-This is how you opt-in your services and link them with the plugin.
+This is how you opt in your services and link them with the plugin.
 
 <!-- tabs:start -->
 
@@ -145,7 +145,7 @@ services:
       - sablier.group=demo
   
   sablier:
-    image: sablierapp/sablier:local
+    image: sablierapp/sablier:1.8.1
     volumes:
       - '/var/run/docker.sock:/var/run/docker.sock'
 ```
@@ -175,4 +175,4 @@ Here we've configured the following things when we're accessing the service on `
 
 <!-- tabs:end -->
 
-?> We've assigned the group `demo` to the service and we use this to identify the workload i
+?> We've assigned the group `demo` to the service, and we use this to identify the workload i
diff --git a/docs/guides/code-server-traefik-kubernetes.md b/docs/guides/code-server-traefik-kubernetes.md
@@ -140,7 +140,6 @@
             app: sablier
         spec:
           serviceAccountName: sablier
-          serviceAccount: sablier
           containers:
           - name: sablier
             image: sablierapp/sablier:1.8.1

diff --git a/docs/index.html b/docs/index.html
@@ -7,7 +7,6 @@
   <meta name="description" content="Description">
   <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
-  <link rel="stylesheet" href="assets/style.css">
   <link rel="icon" type="image/x-icon" href="assets/img/favicon.ico">
   <style>
    :root {

diff --git a/docs/installation.md b/docs/installation.md
@@ -10,7 +10,7 @@ You can install Sablier with the following flavors:
 ## Use the Docker image
 
 - **Docker Hub**: [sablierapp/sablier](https://hub.docker.com/r/sablierapp/sablier)
-- **Github Container Registry**: [ghcr.io/sablierapp/sablier](https://github.com/sablierapp/sablier/pkgs/container/sablier)
+- **GitHub Container Registry**: [ghcr.io/sablierapp/sablier](https://github.com/sablierapp/sablier/pkgs/container/sablier)
 
 Choose one of the Docker images and run it with one sample configuration file:
 

diff --git a/docs/plugins/caddy.md b/docs/plugins/caddy.md
@@ -22,21 +22,19 @@ Here I'll show you two options with Docker.
 #### **Using the provided Dockerfile**
 
 ```bash
-docker build https://github.com/sablierapp/sablier.git#v1.4.0-beta.3:plugins/caddy 
-  --build-arg=CADDY_VERSION=2.6.4
-  -t caddy:2.6.4-with-sablier
+docker build https://github.com/sablierapp/sablier.git#v1.8.1:plugins/caddy 
+  --build-arg=CADDY_VERSION=2.8.4
+  -t caddy:2.8.4-with-sablier
 ```
 
 #### **Updating your Caddy Dockerfile**
 
 ```docker
-ARG CADDY_VERSION=2.6.4
+ARG CADDY_VERSION=2.8.4
 FROM caddy:${CADDY_VERSION}-builder AS builder
 
-ADD https://github.com/sablierapp/sablier.git#v1.4.0-beta.3 /sablier
-
 RUN xcaddy build \
-    --with github.com/sablierapp/sablier/plugins/caddy=/sablier/plugins/caddy
+    --with github.com/sablierapp/sablier/plugins/caddy
 
 FROM caddy:${CADDY_VERSION}
 
@@ -73,7 +71,7 @@ You can have the following configuration:
 
 ### Exemple with a minimal configuration
 
-Almost all options are optional and you can setup very simple rules to use the server default values.
+Almost all options are optional, and you can set up very simple rules to use the server default values.
 
 ```Caddyfile
 :80 {

diff --git a/docs/providers/docker.md b/docs/providers/docker.md
@@ -4,7 +4,7 @@ The Docker provider communicates with the `docker.sock` socket to start and stop
 
 ## Use the Docker provider
 
-In order to use the docker provider you can configure the [provider.name](TODO) property.
+In order to use the docker provider you can configure the [provider.name](../configuration) property.
 
 <!-- tabs:start -->
 
@@ -61,4 +61,4 @@ services:
 
 If the container defines a Healthcheck, then it will check for healthiness before stating the `ready` status.
 
-If the containers does not define a Healthcheck, then as soon as the container has the status `started`
+If the containers do not define a Healthcheck, then as soon as the container has the status `started`
diff --git a/docs/providers/docker_swarm.md b/docs/providers/docker_swarm.md
@@ -4,7 +4,7 @@ The Docker Swarm provider communicates with the `docker.sock` socket to scale se
 
 ## Use the Docker Swarm provider
 
-In order to use the docker swarm provider you can configure the [provider.name](TODO) property.
+In order to use the docker swarm provider you can configure the [provider.name](../configuration) property.
 
 <!-- tabs:start -->
 

diff --git a/docs/providers/kubernetes.md b/docs/providers/kubernetes.md
@@ -4,7 +4,7 @@ Sablier assumes that it is deployed within the Kubernetes cluster to use the Kub
 
 ## Use the Kubernetes provider
 
-In order to use the kubernetes provider you can configure the [provider.name](TODO) property.
+In order to use the kubernetes provider you can configure the [provider.name](../configuration) property.
 
 <!-- tabs:start -->