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.

Sign up for GitHub

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

Edit docs for bots #3895

Merged
merged 3 commits into from
Dec 22, 2024
Merged

Edit docs for bots #3895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6a5596
Edit docs/configuring-playbook-bot-buscarron.md: fix list items
Dec 21, 2024
93c8603
Edit docs for bots: fix sentences in the usage sections
Dec 20, 2024
3be6043
Update POT files
Dec 22, 2024
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
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-baibot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

## Usage

To use the bot, invite the `@baibot:example.com` bot user into a room.
To use the bot, invite it to any existing Matrix room (`/invite @baibot:example.com` where `example.com` is your base domain, not the `matrix.` domain).

If you're an allowed bot [👥 user](https://github.com/etkecc/baibot/blob/main/docs/access.md#user) (see [👥 Initial users configuration](#-initial-users-configuration)), the bot will accept your invitation and join the room.

Expand Down
12 changes: 8 additions & 4 deletions docs/configuring-playbook-bot-buscarron.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,11 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

## Usage

To use the bot, invite the `@bot.buscarron:example.com` to the room you specified in a config, after that any point your form to the form url, example for the `contact` form:
To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.buscarron:example.com` where `example.com` is your base domain, not the `matrix.` domain).

After the bot joins the room, anyone can call the web form via HTTP POST method.

Here is an example for the `contact` form:

```html
<form method="POST" action="https://buscarron.example.com/contact">
Expand All @@ -85,9 +89,9 @@ To use the bot, invite the `@bot.buscarron:example.com` to the room you specifie

**Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:

- if you hit the homepage (HTTP `GET` request to `/`)
- if you submit a form to the wrong URL (`POST` request to `/non-existing-form`)
- if `hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field
- you hit the homepage (HTTP `GET` request to `/`)
- you submit a form to the wrong URL (`POST` request to `/non-existing-form`)
- `hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field

If you get banned, you'd need to restart the process by running the playbook with `--tags=start` or running `systemctl restart matrix-bot-buscarron` on the server.

Expand Down
4 changes: 3 additions & 1 deletion docs/configuring-playbook-bot-chatgpt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

## Usage

To use the bot, invite the `@bot.chatgpt:example.com` to the room you specified in a config, after that start speaking to it, use the prefix if you configured one or mention the bot.
To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.chatgpt:example.com` where `example.com` is your base domain, not the `matrix.` domain).

After the bot joins the room, you can send a message to it. When you do so, use the prefix if you configured it or mention the bot.

You can also refer to the upstream [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot).
4 changes: 3 additions & 1 deletion docs/configuring-playbook-bot-honoroit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

## Usage

To use the bot, invite the `@honoroit:example.com` to the room you specified in config, after that any Matrix user can send a message to the `@honoroit:example.com` to start a new thread in that room.
To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @honoroit:example.com` where `example.com` is your base domain, not the `matrix.` domain).

After the bot joins the room, any Matrix user can send a message to it to start a new thread in that room.

Send `!ho help` to the bot in the room to see the available commands.

Expand Down
4 changes: 2 additions & 2 deletions i18n/translation-templates/docs/configuring-playbook-bot-baibot.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: matrix-docker-ansible-deploy \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-12-20 23:17+0900\n"
"POT-Creation-Date: 2024-12-22 11:54+0900\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -384,7 +384,7 @@ msgid "Usage"
msgstr ""

#: ../../../docs/configuring-playbook-bot-baibot.md:386
msgid "To use the bot, invite the `@baibot:example.com` bot user into a room."
msgid "To use the bot, invite it to any existing Matrix room (`/invite @baibot:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
msgstr ""

#: ../../../docs/configuring-playbook-bot-baibot.md:388
Expand Down
30 changes: 19 additions & 11 deletions i18n/translation-templates/docs/configuring-playbook-bot-buscarron.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: matrix-docker-ansible-deploy \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-12-20 07:23+0200\n"
"POT-Creation-Date: 2024-12-22 11:54+0900\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -101,29 +101,37 @@ msgid "Usage"
msgstr ""

#: ../../../docs/configuring-playbook-bot-buscarron.md:78
msgid "To use the bot, invite the `@bot.buscarron:example.com` to the room you specified in a config, after that any point your form to the form url, example for the `contact` form:"
msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.buscarron:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
msgstr ""

#: ../../../docs/configuring-playbook-bot-buscarron.md:86
#: ../../../docs/configuring-playbook-bot-buscarron.md:80
msgid "After the bot joins the room, anyone can call the web form via HTTP POST method."
msgstr ""

#: ../../../docs/configuring-playbook-bot-buscarron.md:82
msgid "Here is an example for the `contact` form:"
msgstr ""

#: ../../../docs/configuring-playbook-bot-buscarron.md:90
msgid "**Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:"
msgstr ""

#: ../../../docs/configuring-playbook-bot-buscarron.md:88
msgid "if you hit the homepage (HTTP `GET` request to `/`)"
#: ../../../docs/configuring-playbook-bot-buscarron.md:92
msgid "you hit the homepage (HTTP `GET` request to `/`)"
msgstr ""

#: ../../../docs/configuring-playbook-bot-buscarron.md:89
msgid "if you submit a form to the wrong URL (`POST` request to `/non-existing-form`)"
#: ../../../docs/configuring-playbook-bot-buscarron.md:93
msgid "you submit a form to the wrong URL (`POST` request to `/non-existing-form`)"
msgstr ""

#: ../../../docs/configuring-playbook-bot-buscarron.md:90
msgid "if `hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field"
#: ../../../docs/configuring-playbook-bot-buscarron.md:94
msgid "`hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field"
msgstr ""

#: ../../../docs/configuring-playbook-bot-buscarron.md:92
#: ../../../docs/configuring-playbook-bot-buscarron.md:96
msgid "If you get banned, you'd need to restart the process by running the playbook with `--tags=start` or running `systemctl restart matrix-bot-buscarron` on the server."
msgstr ""

#: ../../../docs/configuring-playbook-bot-buscarron.md:94
#: ../../../docs/configuring-playbook-bot-buscarron.md:98
msgid "You can also refer to the upstream [documentation](https://github.com/etkecc/buscarron)."
msgstr ""
8 changes: 6 additions & 2 deletions i18n/translation-templates/docs/configuring-playbook-bot-chatgpt.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: matrix-docker-ansible-deploy \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-12-20 07:23+0200\n"
"POT-Creation-Date: 2024-12-22 11:54+0900\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -105,9 +105,13 @@ msgid "Usage"
msgstr ""

#: ../../../docs/configuring-playbook-bot-chatgpt.md:73
msgid "To use the bot, invite the `@bot.chatgpt:example.com` to the room you specified in a config, after that start speaking to it, use the prefix if you configured one or mention the bot."
msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.chatgpt:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
msgstr ""

#: ../../../docs/configuring-playbook-bot-chatgpt.md:75
msgid "After the bot joins the room, you can send a message to it. When you do so, use the prefix if you configured it or mention the bot."
msgstr ""

#: ../../../docs/configuring-playbook-bot-chatgpt.md:77
msgid "You can also refer to the upstream [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot)."
msgstr ""
10 changes: 7 additions & 3 deletions i18n/translation-templates/docs/configuring-playbook-bot-honoroit.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: matrix-docker-ansible-deploy \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-12-20 23:17+0900\n"
"POT-Creation-Date: 2024-12-22 11:54+0900\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -105,13 +105,17 @@ msgid "Usage"
msgstr ""

#: ../../../docs/configuring-playbook-bot-honoroit.md:69
msgid "To use the bot, invite the `@honoroit:example.com` to the room you specified in config, after that any Matrix user can send a message to the `@honoroit:example.com` to start a new thread in that room."
msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @honoroit:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
msgstr ""

#: ../../../docs/configuring-playbook-bot-honoroit.md:71
msgid "Send `!ho help` to the bot in the room to see the available commands."
msgid "After the bot joins the room, any Matrix user can send a message to it to start a new thread in that room."
msgstr ""

#: ../../../docs/configuring-playbook-bot-honoroit.md:73
msgid "Send `!ho help` to the bot in the room to see the available commands."
msgstr ""

#: ../../../docs/configuring-playbook-bot-honoroit.md:75
msgid "You can also refer to the upstream [documentation](https://github.com/etkecc/honoroit#features)."
msgstr ""
Loading