attr_list, start and deployment pages, more about public instance #4
@ -1,3 +1,29 @@
|
|||||||
# Public instance
|
# Public instance
|
||||||
|
|
||||||
This section is under construction.
|
There is a publicly available hosted version of the API and all clients.
|
||||||
|
|
||||||
|
## When to use public instance
|
||||||
|
|
||||||
|
You should use public instance if:
|
||||||
|
|
||||||
|
* You need garbage reminders for [Gemeinde Schmitten](https://www.schmitten.de){:target="_blank"}
|
||||||
|
* You need a stable bot and API versions with good uptime
|
||||||
|
* You want to contribute [locations](locations.md) and/or [entries](entries.md)
|
||||||
|
* You need community and developer [support](report.md)
|
||||||
|
|
||||||
|
You should **NOT** use public instance if:
|
||||||
|
|
||||||
|
* You want to modify the source code
|
||||||
|
* You have non-standard garbage types
|
||||||
|
* You want to add non-standardized locations
|
||||||
|
|
||||||
|
## Start using it
|
||||||
|
|
||||||
|
### API
|
||||||
|
|
||||||
|
* Endpoint: <https://api.garbagebot.eu>{:target="_blank"}
|
||||||
|
* Docs: [Swagger](https://api.garbagebot.eu/docs){:target="_blank"} / [Redoc](https://api.garbagebot.eu/redoc){:target="_blank"}
|
||||||
|
|
||||||
|
### Telegram Bot
|
||||||
|
|
||||||
|
* Link: <https://t.me/GarbageReminder_Bot>{:target="_blank"}
|
||||||
|
11
docs/deployment.md
Normal file
11
docs/deployment.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# Deployment
|
||||||
|
|
||||||
|
Bare minimum installation requires a database and an API. Then you can use any way you like to connect to the API.
|
||||||
|
We provide Telegram bot and raw HTTP for that now, but Discord bot and CLI are planned too.
|
||||||
|
|
||||||
|
Here is how the "normal" deployment process looks like:
|
||||||
|
|
||||||
|
1. Install the requirements [[API](api/installation.md#requirements)/[Telegram](bot_telegram/installation.md#requirements)]
|
||||||
|
2. Install the API server [[Guide](api/installation.md/#installation-process)]
|
||||||
|
3. Install the client/bot of your linking [[Telegram](bot_telegram/installation.md)]
|
||||||
|
4. Fill the API/bot with the data [[API](api/feeding-data.md)/[Telegram](bot_telegram/feeding-data.md)]
|
@ -13,15 +13,3 @@ We provide chatbots as clients. These bots provide the access to the data stored
|
|||||||
After seeing that most cities and villages around only offer proprietary software/websites or even no digital information
|
After seeing that most cities and villages around only offer proprietary software/websites or even no digital information
|
||||||
about garbage collection at all, it was decided to develop an own solution to this problem by storing the data in a
|
about garbage collection at all, it was decided to develop an own solution to this problem by storing the data in a
|
||||||
database and then show the data the way it is helpful for the end-user.
|
database and then show the data the way it is helpful for the end-user.
|
||||||
|
|
||||||
## Deployment
|
|
||||||
|
|
||||||
Bare minimum installation requires a database and an API. Then you can use any way you like to connect to the API.
|
|
||||||
We provide Telegram bot and raw HTTP for that now, but Discord bot and CLI are planned too.
|
|
||||||
|
|
||||||
Here is how the "normal" deployment process looks like:
|
|
||||||
|
|
||||||
1. Install the requirements [[API](api/installation.md#requirements)/[Telegram](bot_telegram/installation.md#requirements)]
|
|
||||||
2. Install the API server [[Guide](api/installation.md)]
|
|
||||||
3. Install the client/bot of your linking [[Telegram](bot_telegram/installation.md)]
|
|
||||||
4. Fill the API/bot with the data [[API](api/feeding-data.md)/[Telegram](bot_telegram/feeding-data.md)]
|
|
||||||
|
17
docs/start-using.md
Normal file
17
docs/start-using.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# Start using
|
||||||
|
|
||||||
|
There are two common usage scenarios: using public instance and deploying your own.
|
||||||
|
|
||||||
|
## Using public instance
|
||||||
|
|
||||||
|
While limited in coverage, public instance offers the access to the latest stable version of the API and chat-bots.
|
||||||
|
|
||||||
|
* [Public API](https://api.garbagebot.eu/redoc){:target="_blank"}
|
||||||
|
* [Public Telegram Bot](https://t.me/GarbageReminder_Bot){:target="_blank"}
|
||||||
|
|
||||||
|
You can find out more about public instance in the [Public instance](community/public/index.md) section.
|
||||||
|
|
||||||
|
## Deploying own instance
|
||||||
|
|
||||||
|
For more personalized experience, you can deploy your own API and clients wherever you want to.
|
||||||
|
Follow the [deployment guide](deployment.md) for detailed instructions.
|
@ -4,6 +4,8 @@ repo_name: GarbageReminder
|
|||||||
nav:
|
nav:
|
||||||
- Home:
|
- Home:
|
||||||
- index.md
|
- index.md
|
||||||
|
- Start using: start-using.md
|
||||||
|
- Deployment: deployment.md
|
||||||
- API:
|
- API:
|
||||||
- api/index.md
|
- api/index.md
|
||||||
- Installation: api/installation.md
|
- Installation: api/installation.md
|
||||||
@ -77,21 +79,21 @@ theme:
|
|||||||
palette:
|
palette:
|
||||||
- media: "(prefers-color-scheme)"
|
- media: "(prefers-color-scheme)"
|
||||||
toggle:
|
toggle:
|
||||||
icon: material/link
|
icon: material/brightness-auto
|
||||||
name: Switch to light mode
|
name: Switch to light mode
|
||||||
- media: "(prefers-color-scheme: light)"
|
- media: "(prefers-color-scheme: light)"
|
||||||
scheme: default
|
scheme: default
|
||||||
primary: custom
|
primary: custom
|
||||||
accent: custom
|
accent: custom
|
||||||
toggle:
|
toggle:
|
||||||
icon: material/toggle-switch
|
icon: material/brightness-7
|
||||||
name: Switch to dark mode
|
name: Switch to dark mode
|
||||||
- media: "(prefers-color-scheme: dark)"
|
- media: "(prefers-color-scheme: dark)"
|
||||||
scheme: slate
|
scheme: slate
|
||||||
primary: custom
|
primary: custom
|
||||||
accent: custom
|
accent: custom
|
||||||
toggle:
|
toggle:
|
||||||
icon: material/toggle-switch-off
|
icon: material/brightness-5
|
||||||
name: Switch to system preference
|
name: Switch to system preference
|
||||||
font:
|
font:
|
||||||
text: Roboto
|
text: Roboto
|
||||||
@ -99,6 +101,7 @@ theme:
|
|||||||
icon:
|
icon:
|
||||||
logo: logo
|
logo: logo
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
|
- attr_list
|
||||||
- pymdownx.details
|
- pymdownx.details
|
||||||
- pymdownx.superfences
|
- pymdownx.superfences
|
||||||
- pymdownx.tabbed:
|
- pymdownx.tabbed:
|
||||||
|
Loading…
Reference in New Issue
Block a user