Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: usage, privacy policy #61

Merged
merged 3 commits into from
Sep 1, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/images/covid.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/devread.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/dukun-leaderboard.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/dukun.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/eval.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/search.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/snap.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Bot for Teknologi Umum

> Click here for [README but in Indonesian language](./README_id.md)
> Klik disini untuk [README namun dalam Bahasa Indonesia](./README_id.md)

Basically a _bleeding edge_ telegram bot to fulfill Teknologi Umum's _bleeding edge_ needs. Teknologi Umum is an Indonesian telegram group made for people to talk about.. basically anything. You can join through [this link](https://t.me/teknologi_umum). First thing you need to do is mute the group, it's so noisy.

What can this bot do? Well, _bleeding edge_ stuffs! You'll find everything when you interact with [the bot on Telegram](https://t.me/TeknologiUmumBot).
What can this bot do? Well, _bleeding edge_ stuffs! You'll find everything when you interact with [the bot on Telegram](https://t.me/TeknologiUmumBot) or read straight away to the [usage documentation](./docs/USAGE.md).

Feel free to contribute and add some _bleeding edge_ features.

Expand Down Expand Up @@ -53,3 +53,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
```

See full license [here](./LICENSE).

## Privacy Policy

See [PRIVACY_POLICY](./docs/PRIVACY_POLICY.md).
6 changes: 5 additions & 1 deletion README_id.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Sebuah bot _bleeding edge_ untuk memenuhi kebutuhan Teknologi Umum yang tidak kalah _bleeding edge_. Teknologi Umum merupakan grup telegram yang diciptakan untuk membicarakan.. apapun. Kamu bisa masuk grup melalui [link ini](https://t.me/teknologi_umum). Hal pertama yang harus kamu lakukan adalah mute grupnya, berisik banget.

Bot ini bisa apa saja? Tentunya bisa melakukan hal-hal _bleeding edge_! Kamu akan tau setelah kamu berinteraksi dengan [botnya Telegram](https://t.me/TeknologiUmumBot)
Bot ini bisa apa saja? Tentunya bisa melakukan hal-hal _bleeding edge_! Kamu akan tau setelah kamu berinteraksi dengan [botnya Telegram](https://t.me/TeknologiUmumBot) atau baca langsung ke [dokumentasi penggunaan](./docs/USAGE_id.md).

Kontribusi sangat dipersilahkan, apalagi untuk menambahkan fitur _bleeding edge_.

Expand Down Expand Up @@ -53,3 +53,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
```

Lihat lisensi lengkapnya [disini](./LICENSE)

## Privacy Policy

Lihat [PRIVACY_POLICY](./docs/PRIVACY_POLICY.md).
44 changes: 44 additions & 0 deletions docs/PRIVACY_POLICY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Privacy Policy

**TL;DR**

We collect your user ID, username, first name, last name, group chat ID and information about it,
and your message if there is any error happened. It will ease our bug-fixing times.
Then we send that to Sentry. Nothing dangerous and concerning about that.

## What information do we collect?

We collect your Telegram user ID, username (if any), first name (if any), and last name (if any).
We also collect the group chat ID, group chat name, group chat username, group chat type
(supergroup, channel, group, or private), and your message on the group.
All of that is collected ONLY IF there is any error happened.

Even if there is an error happened, there should be a message of:

> uh oh, something went wrong. ask the devs to check their logs.

On some commands, we collect just your Telegram user ID, username (if any) first name (if any), last name (if any),
aldy505 marked this conversation as resolved.
Show resolved Hide resolved
and group chat ID to be able to process some commands like `/dukun`, `/snap`, and `/quiz`.

Those data is open for public via the Telegram API. It's not exposing your password or
any credentials-related information. Even your phone number!

## What do we use your information for?

Bug fix, pin pointing where the error came from.
`/dukun` command needs your ID and name to indicate who's who.
That's it.

## How do we protect your information?

For error logging, we use a third party service called Sentry. They uses SSL connection to send data.
You can read about [Sentry's privacy policy here](https://sentry.io/privacy/).

For other cases, we use MongoDB Atlas for our NoSQL database needs. They also uses SSL connectoion.
aldy505 marked this conversation as resolved.
Show resolved Hide resolved
You can read about [MongoDB's privacy policy here](https://www.mongodb.com/legal/privacy-policy).
They did not collect what's inside the database, so we are in good hands.

## Do you log the whole chat data?

No. We don't have enough resources (databases & memory storage space) to do that.
Everything you see on this repository is literally what runs the bot.
158 changes: 158 additions & 0 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
# Usage Guide

> Klik disini untuk [dokumentasi penggunaan namun dalam Bahasa Indonesia](./USAGE_id.md)

In this document you will find how to use Teknologi Umum Bot. Its' commands and available parameters.

## Contents

- 💙 [`/blidingej`](#-blidingej)
- 💙 [`/quiz`](#-quiz)
- 🌏📬 [`/covid`](#-covid)
- 🌏📬 [`/devread`](#-devread)
- 🌏 [`/dukun`](#-dukun)
- 🌏📬 [`/eval`](#-eval)
- 🌏📬 [`/search`](#-search)
- 🌏📬 [`/snap`](#-snap)
- 🌏📬 [`/help`](#-help)
- 🛩📬 [`/kktbsys`](#-kktbys)
- 🛩📬 [`/illuminati`](#-illuminati)
- 🛩📬 [`/joke`](#-joke)
- 🛩📬 [`/quote`](#-quote)
- 🛩📬 [`/yntkts`](#-yntkts)

Legends:

- 💙 Teknologi Umum group only
- 🌏 Available on groups
- 🛩 Available on groups less than 500 members
- 📬 Available on private chats
- 🚧 Experimental feature
- 🚨 Deprecated

## `/blidingej`

Will send you the definition of bliding ej.

Available only on Teknologi Umum Group.

- `/blidingej`
- `/blidingej indo` or `/blidingej id` - Indonesian translation

## `/quiz`

Will send you a random quiz. Whether it'd be TOKI, general programming, or some tech-related trivia.
aldy505 marked this conversation as resolved.
Show resolved Hide resolved

Available only on Teknologi Umum Group.

- `/quiz`

## `/covid`

Will send you Covid-19 statistic information

- `/covid` - Global & Indonesia statistic
- `/covid <country>` - That specific country statistic

<img src="../.github/images/covid.jpg" width="300px" />

## `/devread`

Will send you a collection of developer articles and posts around a certain topic from pulo.dev.

- `/devread <topic>`

<img src="../.github/images/devread.jpg" width="300px" />

## `/dukun`

Dukun is an Indonesian term for shaman or sorcerer.
It's kind of a joke for specifying those who could answer a given problem without any details about it whatsoever.

Not available on private chats.

Reply to other person's message with `/dukun +<point>` or `/dukun -<point>` to give them a dukun point.
Maximum point given for a person is +10 and -10.

Be careful of using this, it's a competitive life.

- `/dukun` - Shows dukun leaderboard
- `/dukun +<point>` - Increment someone's dukun point
- `/dukun -<point>` - Decrement someone's dukun point

<img src="../.github/images/dukun-leaderboard.jpg" width="300px" />
<img src="../.github/images/dukun.jpg" width="300px" />

## `/eval`

Evaluate javascript expression, and shows the output. Bear in mind we limit the usage of a lots of stuff.
aldy505 marked this conversation as resolved.
Show resolved Hide resolved
If you want to produce more powerful things, please create it on [JSBin](https://jsbin.com/),[JSFiddle](http://jsfiddle.net/),
[Codepen](https://codepen.io/), [Codesandbox](https://codesandbox.io/), or even [Repl.it](https://repl.it/).

- `/eval <javascript expression>`

<img src="../.github/images/eval.jpg" width="300px" />

## `/search`

Shows you 10 results from a DuckDuckGo search. As simple as that. No ads. Filtered clean search results by the algorithm.
elianiva marked this conversation as resolved.
Show resolved Hide resolved

- `/search <query>`

<img src="../.github/images/search.jpg" width="300px" />

## `/snap`

Snap a given code snippets with [Carbon.now.sh](https://carbon.now.sh/).

Send a code snippet, and reply to that message with `/snap`. You will get the code captured and served beautifully.

- `/snap`

<img src="../.github/images/snap.jpg" width="300px" />

## `/help`

Gives information about the bot

- `/help`

## `/kktbsys`

Sends you a Soeharto's "Kok kamu tanya begitu, siapa yang suruh?" meme.

Only available in groups less than 500 members and private chats.

- `/kktbsys`

## `/illuminati`

Sends you an illuminati GIF.

Only available in groups less than 500 members and private chats.

- `/illuminati`

## `/joke`

Sends you a random Indonesian dad jokes in picture format.

Only available in groups less than 500 members and private chats.

- `/joke`

## `/quote`

Sends you a random quote from someone famous. Or at least, the API think they are famous.

Only available in groups less than 500 members and private chats.

- `/quote`

## `/yntkts`

Sends you a Jokowi's "Yo ndak tahu kok tanya saya" meme.

Only available in groups less than 500 members and private chats.

- `/yntkts`
157 changes: 157 additions & 0 deletions docs/USAGE_id.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
# Usage Guide

> Click here for [usage documentation in English](./USAGE.md)

Pada dokumen ini, kamu akan menemukan cara menggunakan Teknologi Umum Bot. Command berikut dengan parameter yang tersedia.

## Contents

- 💙 [`/blidingej`](#-blidingej)
- 💙 [`/quiz`](#-quiz)
- 🌏📬 [`/covid`](#-covid)
- 🌏📬 [`/devread`](#-devread)
- 🌏 [`/dukun`](#-dukun)
- 🌏📬 [`/eval`](#-eval)
- 🌏📬 [`/search`](#-search)
- 🌏📬 [`/snap`](#-snap)
- 🌏📬 [`/help`](#-help)
- 🛩📬 [`/kktbsys`](#-kktbys)
- 🛩📬 [`/illuminati`](#-illuminati)
- 🛩📬 [`/joke`](#-joke)
- 🛩📬 [`/quote`](#-quote)
- 🛩📬 [`/yntkts`](#-yntkts)

Legends:

- 💙 Hanya di grup Teknologi Umum
- 🌏 Tersedia di grup
- 🛩 Tersedia di grup kurang dari 500 anggota
- 📬 Tersedia di pesan privat
- 🚧 Fitur eksperimental
- 🚨 Akan segera dihapus

## `/blidingej`

Akan mengirimkan definisi dari bliding ej.

Hanya tersedia di grup Teknologi Umum.

- `/blidingej`
- `/blidingej indo` atau `/blidingej id` - Terjemah Bahasa Indonesia

## `/quiz`

Akan mengirimkan kuis acak. Baik itu kuis TOKI, pemrogramman umum, atau trivia terkait teknologi.

Hanya tersedia di grup Teknologi Umum.

- `/quiz`

## `/covid`

Akan mengirimkan informasi statistik Covid-19

- `/covid` - Statistik global & Indonesia
- `/covid <negara>` - Statistik spesifik negara tersebut

<img src="../.github/images/covid.jpg" width="300px" />

## `/devread`

Akan mengirimkan kumpulan artikel atau postingan dari developer terkait topik tertentu dari pulo.dev.

- `/devread <topik>`

<img src="../.github/images/devread.jpg" width="300px" />

## `/dukun`

Semacam bercandaan untuk mereka yang dapat menjawab suatu masalah tanpa penjelasan lebih lanjut tentang masalah tersebut.

Tidak tersedia di pesan privat.

Balas ke pesan orang lain dengan `/dukun +<poin>` atau `/dukun -<poin>` untuk memberikan mereka poin dukun.
Poin maksimum yang dapat diberikan kepada seseorang adalah +10 dan -10.

Hati-hati menggunakan ini, hidup itu kompetitif.

- `/dukun` - Menunjukan papan peringkat dukun
- `/dukun +<poin>` - Menambah poin dukun seseorang
- `/dukun -<poin>` - mengurangi poin dukun seseorang

<img src="../.github/images/dukun-leaderboard.jpg" width="300px" />
<img src="../.github/images/dukun.jpg" width="300px" />

## `/eval`

Mengevaluasi ekspresi javascript dan memberikan hasilnya. Perlu diingat bahwa kami membatasi penggunaan untuk banyak hal.
Kalau kamu ingin memproduksi hal-hal yang lebih _powerful_, bisa dibuat pada [JSBin](https://jsbin.com/),
[JSFiddle](http://jsfiddle.net/), [Codepen](https://codepen.io/), [Codesandbox](https://codesandbox.io/), atau [Repl.it](https://repl.it/).

- `/eval <ekspresi javascript>`

<img src="../.github/images/eval.jpg" width="300px" />

## `/search`

Memberikan 10 hasil pencarian dari DuckDuckGo. Sesederhana itu. Tanpa iklan. Hasil pencarian bersih tersaring oleh algoritma.

- `/search <query>`

<img src="../.github/images/search.jpg" width="300px" />

## `/snap`

Memberikan gambar dari sebuah cuplikan kode dengan [Carbon.now.sh](https://carbon.now.sh/).

Kirim cuplikan kode (dalam pesan), dan balas ke pesan itu dengan `/snap`. Kamu akan mendapatkan gambar dari kode tersebut.

- `/snap`

<img src="../.github/images/snap.jpg" width="300px" />

## `/help`

Memberikan informasi tentang bot.

- `/help`

## `/kktbsys`

Memberikan meme Soeharto, "Kok kamu tanya begitu, siapa yang suruh?".

Hanya tersedia di grup kurang dari 500 orang dan pesan privat.

- `/kktbsys`

## `/illuminati`

Mengirimkan GIF illuminati.

Hanya tersedia di grup kurang dari 500 orang dan pesan privat.

- `/illuminati`

## `/joke`

Mengirimkan gambar jokes bapack2.

Hanya tersedia di grup kurang dari 500 orang dan pesan privat.

- `/joke`

## `/quote`

Mengirimkan kutipan acak dari seseorang yang terkenal. Atau paling tidak, API-nya menganggap mereka terkenal.

Hanya tersedia di grup kurang dari 500 orang dan pesan privat.

- `/quote`

## `/yntkts`

Mengirimkan meme Jokowi, "Yo ndak tahu kok tanya saya".

Hanya tersedia di grup kurang dari 500 orang dan pesan privat.

- `/yntkts`
Loading