Commit Graph
100 Commits
Author SHA1 Message Date
Suguru Hirahara 6814ead8fc Update docs/configuring-playbook-ma1sd.md: fix configuration for increasing logging verbosity
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 13:55:52 +09:00
Suguru Hirahara aaf76adbd7 Update files for matrix-bridge-wechat: sort the logging verbosity levels
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 13:11:59 +09:00
Suguru Hirahara 855ba5581a Update files for matrix-bridge-wechat: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 13:11:52 +09:00
Suguru Hirahara 16d3d0e3fe Update docs/configuring-playbook-bridge-wechat.md: add the section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 13:10:27 +09:00
Suguru Hirahara eb5831efa3 Update files for ma1sd: add the common section "Increase logging verbosity"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 02:02:15 +09:00
Suguru Hirahara cf01549168 Update docs/configuring-playbook-ma1sd.md: adopt the common format for the section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 02:01:59 +09:00
Suguru Hirahara 8f2c51305a Update files for Email2Matrix: reflect the fact that the component has been deprecated
Unfortunately Email2Matrix has been deprecated this month. See: https://github.com/devture/email2matrix/commit/f1032f0ac8619c3a7b52ec3eca05645237ecc5a6. As a long time user of the component, I'd like to shout out a big thank-you to Slavi!

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 23:21:25 +09:00
Suguru Hirahara 3c33f0be3b Update files for Email2Matrix: fix capitalization
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 23:07:01 +09:00
Suguru Hirahara e1f2d764e5 Update docs/configuring-playbook-email2matrix.md: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 23:06:47 +09:00
Suguru Hirahara fa33e0b4bd Update docs/configuring-playbook-email2matrix.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 23:04:21 +09:00
Suguru Hirahara 1db5f76024 Replace double hyphens with "Em Dash" unicode character (U+2014)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 16:36:14 +09:00
Suguru Hirahara 76e346573c Replace hyphen as dash with "Em Dash" unicode character (U+2014)
This commit replaces hyphen characters used as dash with the actual unicode character for dash. It avoids using HTML character entity reference (&mdash;), because IMHO it would make it a bit harder to read documents as plain markdown files on your local text editor.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 16:35:59 +09:00
Suguru Hirahara abff629e36 Update docs/configuring-playbook-cactus-comments.md: replace "-" with "&mdash;"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:42:44 +09:00
Suguru Hirahara 1f532fe90d Update docs/configuring-playbook-cactus-comments.md: add the configuration for changing the default username (bot.cactusbot)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:40:31 +09:00
Suguru Hirahara 89864c6de0 Update files for cactus-comments: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:22:43 +09:00
Suguru Hirahara 83ad4d4975 Update docs/configuring-playbook-cactus-comments.md: adopt the common instruction to start using the component
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:22:09 +09:00
Suguru Hirahara f2083aa8a7 Update docs/configuring-playbook-cactus-comments.md: replace the placeholders for the site name
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:22:00 +09:00
Suguru Hirahara 7f13747e82 Update docs/configuring-playbook-cactus-comments.md: move the configuration enabled by default
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:21:43 +09:00
Suguru Hirahara 909ca59cb7 Update docs/configuring-playbook-cactus-comments.md: remove the uncommon comment block
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:20:36 +09:00
Suguru Hirahara 50f259d505 Update docs/configuring-playbook-cactus-comments.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:20:24 +09:00
Suguru Hirahara 0dc566f1a3 Update docs/configuring-playbook-bot-buscarron.md: add the common expression for linking to the documentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 22:34:28 +09:00
Suguru Hirahara 2a7111f287 Update docs/configuring-playbook-bot-buscarron.md: add the common section "Troubleshooting"
See roles/custom/matrix-bot-buscarron/defaults/main.yml at 601406ddda for the default log value (INFO).

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 22:32:30 +09:00
Suguru Hirahara 6c19bf509e Update docs/configuring-playbook-bot-buscarron.md: add the section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 22:30:18 +09:00
Suguru Hirahara 5c80c820bc Update docs/configuring-playbook-bridge-hookshot.md: add a period
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 18:24:40 +09:00
Suguru Hirahara acf2b90346 Update files for matrix-bridge-hookshot: change the file path of config.yml.j2 in order to improve consistency
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 18:13:59 +09:00
Suguru Hirahara e8213768a5 Update files for matrix-bridge-hookshot: sort logging levels
Based on docs/configuring-playbook-alertmanager-receiver.md

We can re-sort the levels it if is found out that debug should be placed at the first.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 18:13:31 +09:00
Suguru Hirahara 5c39ef8ca2 Update docs/configuring-playbook-bridge-hookshot.md: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 18:13:20 +09:00
Suguru Hirahara 5b2282de27 Update docs/configuring-playbook-bridge-hookshot.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 18:07:13 +09:00
Suguru Hirahara 21b5963f63 Update files for the matrix-alertmanager-receiver: rename config.yml.j2 to config.yaml.j2 in order to improve consistency
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 12:04:41 +09:00
Suguru Hirahara 42f38dae07 Update docs/configuring-playbook-alertmanager-receiver.md: add the common section "Troubleshooting"
The configuration was copied from main.yml.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 12:04:26 +09:00
Suguru Hirahara d225f52ba2 Update docs/configuring-playbook-alertmanager-receiver.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 12:04:16 +09:00
Suguru Hirahara 30d01cc22d Update docs/configuring-playbook-dimension.md: replace right arrows with actual ones
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 23:01:10 +09:00
Suguru Hirahara 4400d3c06d Update docs/configuring-playbook-dimension.md: create the section "Usage"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 23:00:58 +09:00
Suguru Hirahara 5ea579d4ee Update docs/configuring-playbook-dimension.md: apply the fact that the project has been finished and the update will not be provided
The original description has been added with a0ce5eec64 on 2020.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 22:56:16 +09:00
Suguru Hirahara 9d8dac83cc Update docs/configuring-playbook-dimension.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 22:45:49 +09:00
Suguru Hirahara e6d631c6f1 Update docs/configuring-playbook-bridge-appservice-slack.md: change the instruction into a sentence
Fixing the grammatical structure to avoid word puzzles for better i18n.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 18:02:39 +09:00
Suguru Hirahara 2b4865d44b Update docs/configuring-playbook-bridge-appservice-slack.md: adopt the common expression for troubleshooting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 18:02:19 +09:00
Suguru Hirahara ff7dbcee1b Update docs/configuring-playbook-bridge-appservice-slack.md: add the common section "Extending the configuration"
Also: add an example for "+matrix_appservice_slack_configuration_extension_yaml"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 18:02:05 +09:00
Suguru Hirahara 01050c520d Update roles/custom/matrix-bridge-appservice-slack/defaults/main.yml: fix indentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 17:58:33 +09:00
Suguru Hirahara 4c00e88fa4 Update docs/configuring-playbook-pantalaimon.md: add the common section "Troubleshooting"
The comment was copied from roles/custom/matrix-pantalaimon/defaults/main.yml. The latest status of the variable "matrix_pantalaimon_log_level" can be checked on 55fcaac1f1.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 02:04:46 +09:00
Suguru Hirahara 74e4c2a5bd Update docs/configuring-playbook-pantalaimon.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 01:38:53 +09:00
Suguru Hirahara a6333df04e Update configuring-playbook-bot-baibot.md and configuring-playbook-bridge-postmoogle.md: the common section for troubleshooting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-23 23:30:40 +09:00
Suguru Hirahara e047e860ff Update docs/configuring-playbook-bridge-postmoogle.md: add the section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-23 23:30:31 +09:00
Suguru Hirahara 97418bf2ea Update docs/configuring-playbook-email.md: tidy up
This commit applies the common format to the file.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-23 18:55:00 +09:00
Suguru Hirahara c8ca9489bb Update docs/configuring-playbook-bridge-mautrix-wsproxy.md: move down the section "Extending the configuration" for consistency
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-23 02:11:03 +09:00
Suguru Hirahara fbe32cc17c Update docs/configuring-playbook-backup-borg.md and docs/configuring-playbook-synapse-auto-compressor.md: adopt the common description
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-22 01:38:26 +09:00
Suguru Hirahara 3b685df1ab Update docs for Draupnir and Mjolnir: improve the instructions for running the curl command to disable rate limiting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-21 15:56:24 +09:00
Suguru Hirahara 9d3ef6134b Update roles/custom/matrix-bot-draupnir/defaults/main.yml: make sure what the word "it" means here
Here "it" should not mean "the upstream advice".

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-21 14:53:08 +09:00
Suguru Hirahara 7b979ff7a9 Update roles/custom/matrix-bot-draupnir/defaults/main.yml: replace "when" with "if" for consistency and to clarify that these are conditions
Note that there is no other "when" on this file. It is not sensible to keep these exceptions here.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-21 13:58:04 +09:00
Suguru Hirahara 665f7369d6 Update roles/custom/matrix-bot-draupnir/defaults/main.yml: change the subject who discourages Pantalaimon
This change clarifies that it is the upstream project, not this project owner, that discourages enabling Pantalaimon for Draupnir. This distinction should make it clear who is responsible for the matter.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-21 13:43:12 +09:00
Suguru Hirahara a7e1474c3a Update roles/custom/matrix-bot-draupnir/defaults/main.yml: strip a noisy warning and the order to check in at the upstream
Multiple use of the phrase "you know what you are doing" does not increase its effect but rather makes it noisy instead. Since it is warned with capitalized "DO NOT", it is enough.

Also replace the order to check in at the upstream with the recommendation, as it is inconsistent for this project overall to ask users to do so. It is not sensible to make an exception for Draupnir.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-21 12:48:30 +09:00
Suguru Hirahara 5731bcd222 Update roles/custom/matrix-bot-draupnir/defaults/main.yml: fix another sentence and capitalization
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-21 12:31:16 +09:00
Suguru Hirahara 8fadab4ee8 Change the expression and fix other typos
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-21 12:17:50 +09:00
Suguru Hirahara 66d96844d6 Update docs/configuring-playbook-bot-draupnir.md: move the note about the "ensure-matrix-users-created" playbook tag
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 23:14:34 +09:00
Suguru Hirahara cb0798bc06 Update docs/configuring-playbook-bot-draupnir.md: create and soon invite the bot user to the management room
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 23:13:44 +09:00
Suguru Hirahara c3e9e51385 Update roles/custom/matrix-bot-draupnir/defaults/main.yml: clarify that setting "matrix_bot_draupnir_pantalaimon_use" to false is opinionated
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 18:10:40 +09:00
Suguru Hirahara 9c5cd42af1 Update roles/custom/matrix-bot-draupnir/defaults/main.yml: fix capitalization, typo, and sentences
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 18:10:31 +09:00
Suguru Hirahara 8eb513a49d Update docs for Draupnir and Mjolnir: improve instructions to replace the IDs
Also: replace the placeholder for the clean access token

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 17:58:31 +09:00
Suguru Hirahara 9a0e1e64a8 Update docs for Draupnir and Mjolnir: move the instruction to obtain an access token for the admin account above the one about running the curl command
Also: clarify that it is the admin account that needs to be obtained for Synapse's Admin APIs.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 17:58:18 +09:00
Suguru Hirahara aea2a6d53f Update docs for Draupnir and Mjolnir: create subsections for the instruction about making sure the account is free from rate limiting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 17:57:58 +09:00
Suguru Hirahara 30a53efadd Update docs for Draupnir and Mjolnir: move the note about API access above
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 17:57:30 +09:00
Suguru Hirahara 887db388e8 Apply the review from another PR
Cherry-picked from f7c01cca9c.
Regressed by f15c0a46be.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 16:42:24 +09:00
Suguru Hirahara c4507d42e3 Update docs/configuring-playbook-bot-draupnir.md: add "optoional, recommended" label to the section
Unlike Mjolnir, the step is no longer required. It is optional and recommended on Draupnir, therefore it should be clarified so.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 14:00:19 +09:00
Suguru Hirahara 7186d5fb93 Update docs/configuring-playbook-bot-draupnir.md: add an anchor link to configuring-playbook-bot-mjolnir.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:55:14 +09:00
Suguru Hirahara 2c7914d071 Update docs/configuring-playbook-bot-draupnir.md: invite the Draupnir bot after installation
Now that the bot user for Draupnir is created automatically and you no longer need to register it manually since its 2.0.0 version, it does not seem to be sensible to synchronize descriptions about inviting bots between documents for Draupnir and Mjolnir. It is not friendly to instruct to invite the bot which does not exist just yet, only to let the known error message about the nonexistent user displayed.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:54:35 +09:00
Suguru Hirahara 7b6b103e01 Update docs/configuring-playbook-bot-draupnir.md: misc changes mainly fixing typos
The typos were introduced by f15c0a46be.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:53:37 +09:00
Suguru Hirahara 340e569984 Update docs/configuring-playbook-appservice-draupnir-for-all.md: remove the duplicated instruction to set an alias to the management room
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:51:59 +09:00
Suguru Hirahara 04ff68e229 Update docs for Draupnir and Mjolnir: tidy up the instruction to check the room ID
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:51:49 +09:00
Suguru Hirahara 39625aae15 Update docs for Draupnir and Mjolnir: small edits for the common sentences
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:51:27 +09:00
Suguru Hirahara 4e5532a0d5 Update docs for Draupnir, D4A, and Mjolnir: emphasize the importance of being careful when inviting a user to the management room
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:51:10 +09:00
Suguru Hirahara 8ba607a76a Change capitalization per author's preference: Conduwuit → conduwuit
See: https://github.com/girlbossceo/conduwuit/commit/e8508d16e1f5686881c40ba5b54f7a1a87cbe7e9

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 12:38:37 +09:00
Suguru Hirahara f987d295ee Update docs for Draupnir, D4A, and Mjolnir: adopt the common section "Extending the configuration"
Also: fix the variable "matrix_appservice_draupnir_for_all_configuration_yaml"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 11:43:15 +09:00
Suguru Hirahara 41d0fb8c86 Move config j2 files out of "config" subfolder for consistency
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-18 22:08:04 +09:00
Suguru Hirahara 575d98172a Update docs/configuring-playbook-jitsi.md: add instructions to create vars.yml files for each additional JVB (Jitsi VideoBridge)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-18 17:58:51 +09:00
Suguru Hirahara 686d9935e2 Mentions mash-playbook on feature_request.md and faq.md
Make one of the list items compact for the new item about mash-playbook

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-17 13:53:59 +09:00
Suguru Hirahara 9ffd40bcd2 Remove an obsolete variable: backup_borg_retention_prefix
It has been removed with https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/commit/30f0f92dc5e100848b4ec3ba13f0c26439cf62e8 for updating borgmatic to v1.8.2.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-16 23:07:42 +09:00
Suguru Hirahara a4f9bdebcd Update docs: adopt the common instruction
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-16 13:09:06 +09:00
Suguru Hirahara 310a5448ce Update docs/configuring-dns.md: move down the section about DNS setting for optional server delegation
Now that the large table for DNS settings is gone, it is sensible to move the section about DNS setting for server delegation down, below the section for DNS configuration for default services.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-16 02:50:53 +09:00
Suguru Hirahara eaba9cc75e Replace double or triple dots with horizontal ellipses (“…” U+2026)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-12 00:03:28 +09:00
Suguru Hirahara a6f399f4a0 Update docs/configuring-playbook-synapse-s3-storage-provider.md: fix the path to media-store directory
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-11 17:55:27 +09:00
Suguru Hirahara ff8373c616 Update .github/workflows/close-stale-issues.yml: increase operations-per-run from 100 to 500
Apparently checking issues or PRs which have been labelled with "stale" consumes more operations than checking ones without labelled, and the current amount (100) is not enough. See an example: https://github.com/spantaleev/matrix-docker-ansible-deploy/actions/runs/12566424393/job/35031806537#step:2:4083

Since the total amount of GitHub API rate is 5000, reserving 10 per cent for this action should not be an issue for now. Let's increase again if it is still too low.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-08 11:54:27 +09:00
Suguru Hirahara 516a0035c8 Update docs/configuring-playbook-matrix-media-repo.md: replace an external anchor link with an internal one
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-24 01:53:09 +09:00
Suguru Hirahara 40ef348c48 Update docs: Move "(optional)" on headers to the end of the line
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-24 01:53:00 +09:00
Suguru Hirahara 362d9cabd8 Update docs: add "recommended" to the "optional" label on the headers
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-24 01:52:54 +09:00
Suguru Hirahara a2b9243247 Edit docs/configuring-playbook-email2matrix.md: adopt the common instruction about registering a dedicated user
Based on docs/configuring-playbook-alertmanager-receiver.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-24 01:52:47 +09:00
Suguru Hirahara 2c80aaf980 Edit docs/configuring-playbook-email2matrix.md: adopt the common instruction
Based on docs/configuring-playbook-dimension.md and docs/configuring-playbook-bot-go-neb.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-24 01:52:41 +09:00
Suguru Hirahara 4798888ac7 Edit docs/configuring-playbook-dimension.md: adopt the common instruction for introduction and prerequisites
- Register a dedicated Matrix user (optional)
- Obtain an access token

Since Dimension has been archived, this is purely for possible use as a template of another component.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-24 01:52:32 +09:00
Suguru Hirahara 66ea709cb3 Replace headers for sections about obtaining an access token
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-23 18:18:36 +09:00
Suguru Hirahara 7911cdb232 Add a common warning message about not to share an access token
Based on docs/obtaining-access-tokens.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-23 18:18:08 +09:00
Suguru Hirahara fb05eace5a Edit instructions to obtain an access token
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-23 18:17:10 +09:00
Suguru Hirahara 3ad2211d74 Use common instructions for referring to the documentation on obtaining an access token
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-23 18:15:41 +09:00
Suguru Hirahara 069f1392e0 Update POT files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-23 13:11:49 +09:00
Suguru Hirahara 9a56aff933 Edit docs for bots: adopt the common format
- Add "To use the bot" if it does not exist: adopt the format of the docs for bridges
- Add "Prerequisites" section if an API key or user account is required
- Use the common instruction for getting an access token
- Replace "Get" with "Obtain" about getting keys or access tokens
- Replace placeholders for access tokens on docs/configuring-playbook-bot-go.neb.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-23 13:11:38 +09:00
Suguru Hirahara f044bdd279 Update POT files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-22 17:54:16 +09:00
Suguru Hirahara 6b87d1aa7d Edit docs: consistent instructions to generate passphrases or secrets with pwgen
This commit replaces instructions to create passwords, passphrases, or secrets with common ones.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-22 17:53:14 +09:00
Suguru Hirahara 3be6043b5a Update POT files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-22 12:03:23 +09:00
Suguru Hirahara 93c860305f Edit docs for bots: fix sentences in the usage sections
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-22 12:03:09 +09:00
Suguru Hirahara a6a55961a9 Edit docs/configuring-playbook-bot-buscarron.md: fix list items
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-22 11:54:20 +09:00
Suguru Hirahara e7ea622279 Update POT files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-20 23:18:16 +09:00
Suguru Hirahara e33bd16dc6 Consistent "send help" messages
The common pattern is "Send `.*?` to the bot (in the room) to see the available commands." If the descripions are about a bot being invited to a certain existing room or room which is not DM, then "in the room" is inserted among them.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-20 23:17:20 +09:00