mirrors/sablier
1
0
Fork 0
mirror of https://github.com/sablierapp/sablier.git synced 2025-12-31 18:17:20 +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

14
docs/getting-started.md
View File

@@ -2,28 +2,28 @@
This Getting Started will get you through what you need to understand how to use Sablier as a scale to zero middleware with a reverse proxy.
![integration](assets/img/integration.png)
![integration](/assets/img/integration.png)
## Identify your provider
The first thing you need to do is to identify your [Provider](/providers/overview).
The first thing you need to do is to identify your [Provider](providers/overview).
?> A Provider is how Sablier can interact with your instances and scale them up and down to zero.
You can check the available providers [here](/providers/overview?id=available-providers).
You can check the available providers [here](providers/overview?id=available-providers).
## Identify your reverse proxy
Once you've identified you're [Provider](/providers/overview), you'll want to identify your [Reverse Proxy](/plugins/overview).
Once you've identified you're [Provider](providers/overview), you'll want to identify your [Reverse Proxy](plugins/overview).
?> Because Sablier is designed as an API that can be used on its own, reverse proxy integrations acts as a client of that API.
You can check the available reverse proxy plugins [here](/plugins/overview?id=available-reverse-proxies)
You can check the available reverse proxy plugins [here](plugins/overview?id=available-reverse-proxies)
## Connect it all together
- Let's say we're using the [Docker Provider](/providers/docker).
- Let's say we're using the [Caddy Reverse Proxy Plugin](/plugins/caddy).
- Let's say we're using the [Docker Provider](providers/docker).
- Let's say we're using the [Caddy Reverse Proxy Plugin](plugins/caddy).
### 1. Initial setup with Caddy