Skip to content

Commit

Permalink
docs: add more hyperlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
TendTo committed Dec 17, 2023
1 parent f8c2145 commit db25546
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 11 deletions.
2 changes: 2 additions & 0 deletions docs/source/dbschema.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _dbschema:

Database schema
===========================================
This is the schema of the database used to store information about the spots and their reactions
Expand Down
34 changes: 23 additions & 11 deletions docs/source/privacy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Privacy Policy
Introduction
============

This Privacy Policy describes how we collect, use, and handle your personal information when you use @Spotted_DMI_bot.
This Privacy Policy describes how we collect, use, and handle your personal information when you use |spotted_dmi_bot|_.

Information We Collect
======================

Each user is assigned a unique **UserID** by telegram.
This information is easily obtained by any client or bot and is not to be considered sensitive information.
In fact, it is necessary for the bot to send the user messages.
Each user is assigned a unique |user_id|_ by telegram, which corresponds to their |chat_id|_.
It can be easily obtained by any client or bot and is not to be considered sensitive information.
In fact, it is necessary for the bot to send the user messages, as shown in the prototype of |send_message|_.

How We Use Your Information
===========================

When a spot or report is submitted, the **UserID** is stored in the database.
When a spot or report is submitted, the |user_id|_ is stored in the database.
This is done for the following reasons:

- To notify the user of the outcome of the admin's judgment on your spot.
Expand All @@ -28,11 +28,13 @@ This is done for the following reasons:
- To allow the user to cancel a spot still pending, before receiving the final judgment of the admins.
- To ban a user.

To see more in detail what tables require the |user_id|_, please refer to the :ref:`Database Schema <dbschema>` section.

Are spots and reports anonymous to the admins?
==============================================

**Yes**.
While the bot has to store the **UserID** in order to function, the information is not shared with the admins.
While the bot has to store the |user_id|_ in order to function, the information is not shared with the admins.
Spot and reports are presented to them without any information about the original sender.

Even when replying to a spot or banning an user, the admins are not shown any information that could be used to identify the user.
Expand All @@ -47,21 +49,21 @@ No information about the original sender is available to them.
How long we retain your information for
=======================================

The bot only stores the **UserID** as long as a spot is pending.
The bot only stores the |user_id|_ as long as a spot is pending.
Upon admin's approval or rejection, the record is expunged from the database.
This also happens when the user **/cancel** a spot still pending.

Reports are a different matter.
Again, the **UserID** is stored in order to prevent miss-use and to allow communication between the admins and the user.
Again, the |user_id|_ is stored in order to prevent miss-use and to allow communication between the admins and the user.
But there is currently no system in place to delete reports from the database.

Data Security
=============

The information is stored on the server hosting @Spotted_DMI_bot.
All data is stored on the server hosting |spotted_dmi_bot|_.
Access to the server is restricted to a small subset of the developers of the bot.
All of them are trusted in not accessing the data and keeping it safe and confidential.
In any case, the **UserID** alone provides very little information, since the content of the actual spot is not stored in the database.
In any case, the |user_id|_ alone provides very little information, since the content of the actual spot is not stored in the database.

Sharing of Information
======================
Expand All @@ -81,7 +83,17 @@ If you have any questions or concerns about this Privacy Policy, please contact
Acceptance of Terms
===================

By using @Spotted_DMI_bot, you signify your acceptance of this Privacy Policy.
By using |spotted_dmi_bot|_, you signify your acceptance of this Privacy Policy.
If you do not agree to this policy, please do not use the bot in order to send spots.

This Privacy Policy is effective as of the date stated at the beginning of the document and may be subject to updates. Please review this policy periodically for any changes.

.. |spotted_dmi_bot| replace:: @Spotted_DMI_bot
.. |user_id| replace:: **User.id**
.. |chat_id| replace:: **Chat.id**
.. |send_message| replace:: *sendMessage()*

.. _spotted_dmi_bot: https://t.me/Spotted_DMI_bot
.. _user_id: https://core.telegram.org/bots/api#user
.. _chat_id: https://core.telegram.org/bots/api#chat
.. _send_message: https://core.telegram.org/bots/api#sendmessage

0 comments on commit db25546

Please sign in to comment.