diff --git a/docs/community/public/index.md b/docs/community/public/index.md index 5ab0139..9796642 100644 --- a/docs/community/public/index.md +++ b/docs/community/public/index.md @@ -1,3 +1,29 @@ # 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: {:target="_blank"} +* Docs: [Swagger](https://api.garbagebot.eu/docs){:target="_blank"} / [Redoc](https://api.garbagebot.eu/redoc){:target="_blank"} + +### Telegram Bot + +* Link: {:target="_blank"} diff --git a/docs/deployment.md b/docs/deployment.md index 6d24dc3..e8bf64e 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -6,6 +6,6 @@ We provide Telegram bot and raw HTTP for that now, but Discord bot and CLI are p 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)] +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)] diff --git a/docs/start-using.md b/docs/start-using.md index d780cd9..aeaa77f 100644 --- a/docs/start-using.md +++ b/docs/start-using.md @@ -6,8 +6,8 @@ There are two common usage scenarios: using public instance and deploying your o 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) -* [Public Telegram Bot](https://t.me/GarbageReminder_Bot) +* [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.