From 5a1dd347d075b25edcb2864e7401c0b4ff1fa9b2 Mon Sep 17 00:00:00 2001 From: profitroll Date: Fri, 24 May 2024 22:26:44 +0200 Subject: [PATCH 1/3] Added start and deployment pages --- docs/deployment.md | 11 +++++++++++ docs/index.md | 12 ------------ docs/start-using.md | 17 +++++++++++++++++ mkdocs.yml | 8 +++++--- 4 files changed, 33 insertions(+), 15 deletions(-) create mode 100644 docs/deployment.md create mode 100644 docs/start-using.md diff --git a/docs/deployment.md b/docs/deployment.md new file mode 100644 index 0000000..6d24dc3 --- /dev/null +++ b/docs/deployment.md @@ -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)] +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/index.md b/docs/index.md index c50151d..5a98193 100644 --- a/docs/index.md +++ b/docs/index.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 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. - -## 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)] diff --git a/docs/start-using.md b/docs/start-using.md new file mode 100644 index 0000000..d780cd9 --- /dev/null +++ b/docs/start-using.md @@ -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) +* [Public Telegram Bot](https://t.me/GarbageReminder_Bot) + +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. diff --git a/mkdocs.yml b/mkdocs.yml index d8d4ca3..0df7409 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,8 @@ repo_name: GarbageReminder nav: - Home: - index.md + - Start using: start-using.md + - Deployment: deployment.md - API: - api/index.md - Installation: api/installation.md @@ -77,21 +79,21 @@ theme: palette: - media: "(prefers-color-scheme)" toggle: - icon: material/link + icon: material/brightness-auto name: Switch to light mode - media: "(prefers-color-scheme: light)" scheme: default primary: custom accent: custom toggle: - icon: material/toggle-switch + icon: material/brightness-7 name: Switch to dark mode - media: "(prefers-color-scheme: dark)" scheme: slate primary: custom accent: custom toggle: - icon: material/toggle-switch-off + icon: material/brightness-5 name: Switch to system preference font: text: Roboto -- 2.39.2 From 42d6eb312b38cd5c1d8d77b4b836592c5bbab824 Mon Sep 17 00:00:00 2001 From: profitroll Date: Sun, 26 May 2024 14:26:50 +0200 Subject: [PATCH 2/3] Enabled attr_list --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index 0df7409..09ff8d8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -101,6 +101,7 @@ theme: icon: logo: logo markdown_extensions: + - attr_list - pymdownx.details - pymdownx.superfences - pymdownx.tabbed: -- 2.39.2 From d4e8522687961696cffb0a80eda35253c652daea Mon Sep 17 00:00:00 2001 From: profitroll Date: Sun, 26 May 2024 14:27:12 +0200 Subject: [PATCH 3/3] Added more info about public instance --- docs/community/public/index.md | 28 +++++++++++++++++++++++++++- docs/deployment.md | 2 +- docs/start-using.md | 4 ++-- 3 files changed, 30 insertions(+), 4 deletions(-) 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. -- 2.39.2