- Create sections for the instruction about opening Matrix Federation port
- Remove unmaintained components which this project does not recommend to install from examples about opening the port on docs/prerequisites.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Based on docs/configuring-playbook-dimension.md and docs/configuring-playbook-bot-go-neb.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
- 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>
- 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>
This commit replaces instructions to create passwords, passphrases, or secrets with common ones.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
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>
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3841
Most of the preparation for this was done by Suguru Hirahara (https://github.com/luixxiul).
I've merely reorganized/polished the scripts and instructions in the `i18n/` directory.
While translations can happen even now, more work is necessary to
- make the translation flow better (integrating Weblate), etc.
- restore the Github Actions workflows that Suguru Hirahara had already developed to
adapt them to our new workflow
Usage of matrix_alertmanager_receiver_config_matrix_room_mapping is decribed below in the "Adjusting the playbook configuration" much more nicely.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: fix sections title
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: merge configuration sections
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: small edits
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: remove a note abour Pantalaimon's unavailability
Pantalaimon can be installed and it has become available for matrix-bot-draupnir and matrix-bot-mjolnir already.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: edit instruction of setting an alias to the management room
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-draupnir.md: remove 'c.' from the section title
The section is not related to choosing E2EE support.
Also: replace the instruction to go to the section with the anchor link.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-draupnir.md and docs/configuring-playbook-bot-mjolnir.md: create a section for common configs
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: create "Extending the configuration" sections
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-draupnir.md and docs/configuring-playbook-bot-mjolnir.md: create the "End-to-End Encryption support" section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-mjolnir: adjust the section hierarchy
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: replace numbering
This is a follow-up to e5ab17cafd.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: create "Prerequisites" section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: emphasize necessity of disabling rate limit
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: instruction for discharging rate limit on Synapse
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: edit the placeholder for matrix_bot_draupnir_pantalaimon_password and matrix_bot_mjolnir_pantalaimon_password
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: add an anchor link to "Configuration with E2EE support"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-draupnir.md: move the "Abuse Reports" section above
Also: use "pollReports: true" as an example for extending the configuration.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-draupnir.md and docs/configuring-playbook-bot-mjolnir.md: small edits
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: use a common expression
cf. docs/configuring-playbook-alertmanager-receiver.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: integrate the description for installation by Draupnir into our description
Check the original one: 120b37f3ea
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: fix a typo
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
- Replace links to the documentation with ones to projects' README files, if these have been linked to the project directly
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
The original ID (`@example:example.com`) has not matched with the user IDs which those pages explained on "Registering the bot account" section.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
"To use the bridge, you need to start a chat with …" is well used among the documentation.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
As using `@alice` and `@bob` on this context is confusing, this commit replaces them with `@email2matrix1` and `@email2matrix2`, respectively.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit intends to clarify what "short user ID" means by comparing it with ":matrix.example.com"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
The original ID (`@whatever_you_chose:example.com`) has not matched with the user ID which this page explained above on "Registering the bot user" section.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
- Use common expressions
- Remove a word puzzle for better l10n experience
- Remove a redundant whitespace character
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Suguru Hirahara
Slavi Pantaleev
Suguru Hirahara