Merge pull request 'Added privacy policy and terms of service' (#3) from dev into main

Reviewed-on: #3

docs/community/public/index.md

@@ -1,29 +1,3 @@
 # Public instance
 
-There is a publicly available hosted version of the API and all clients.
+This section is under construction.
-
-## 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"}

docs/deployment.md

@@ -1,11 +0,0 @@
-# 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)]

docs/index.md

@@ -13,3 +13,15 @@ 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)]

docs/start-using.md

@@ -1,17 +0,0 @@
-# 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.

mkdocs.yml

@@ -4,8 +4,6 @@ repo_name: GarbageReminder
 nav:
   - Home:
     - index.md
-    - Start using: start-using.md
-    - Deployment: deployment.md
   - API:
     - api/index.md
     - Installation: api/installation.md
@@ -79,21 +77,21 @@ theme:
   palette:
     - media: "(prefers-color-scheme)"
       toggle:
-        icon: material/brightness-auto
+        icon: material/link
         name: Switch to light mode
     - media: "(prefers-color-scheme: light)"
       scheme: default
       primary: custom
       accent: custom
       toggle:
-        icon: material/brightness-7
+        icon: material/toggle-switch
         name: Switch to dark mode
     - media: "(prefers-color-scheme: dark)"
       scheme: slate
       primary: custom
       accent: custom
       toggle:
-        icon: material/brightness-5
+        icon: material/toggle-switch-off
         name: Switch to system preference
   font:
     text: Roboto
@@ -101,7 +99,6 @@ theme:
   icon:
     logo: logo
 markdown_extensions:
-  - attr_list
   - pymdownx.details
   - pymdownx.superfences
   - pymdownx.tabbed:

requirements.txt

@@ -1 +1 @@
-mkdocs-material~=9.6.0
+mkdocs-material~=9.5.21