Commit Graph

13 Commits

Author SHA1 Message Date
Suguru Hirahara
543f2a5c76
Update documentation of setting up double puppeting with bridges (#3837)
* Update docs/configuring-playbook-bridge-appservice-kakaotalk.md: fix the header for adjusting the playbook configuration

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Move sections "Set up Double Puppeting" under "Usage" as subsections for mautrix bridges and appservice kakaotalk

The changes in this commit reflect double puppeting configuration flow. Since the docs claim that double puppeting can be set up after enabling bridges by chatting with the bridge's bot, the explanation about double puppeting may well be placed under "Usage" as subsection.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Remove notes about setting up double puppeting manually

Since this method is explained after configuring bridges, those notes are no longer necessary.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for mautrix and kakaotalk bridges: add prerequisite(s) section for instructing to install Appservice Double Puppet and/or Shared Secret Auth service

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Replace "Enabling Appservice Double Puppet" with "This"

Enabling Appservice Double Puppet is contrasted with "Enabling double puppeting by enabling the Shared Secret Auth service", therefore it can be just called as "this" if Shared Secret Auth service is not mentioned below.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-bridge-beeper-linkedin.md: follow other instances

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Add 💡 (Light Bulb: U+1F4A1) to the headings

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>
2024-11-29 11:15:30 +02:00
Suguru Hirahara
cd1905f576
Update triple backticks with syntax highlighting (#3832)
* Triple backticks with syntax highlighting: yml → yaml

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Triple backticks with syntax highlighting: yaml and sh

The strings "yml" were replaced with "yaml" as the latter is used more than the former.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Triple backticks with syntax highlighting: INI

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-jitsi.md: remove redundant white space characters after triple backticks

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>
2024-11-28 11:33:56 +02:00
Suguru Hirahara
0b09ad3d76
Update documentation about Slack bridges (#3706)
* Update docs/configuring-playbook-bridge-hookshot.md: matrix-appservice-webhooks has been deprecated

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Add notes that matrix-appservice-slack is not available for new installation

The bridge uses a classic Slack application, but its creation has been discontinued since June 4, 2024.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Remove reference to matrix-hookshot and matrix-appservice-webhooks

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>
2024-10-31 11:58:04 +02:00
Suguru Hirahara
3d47e0d69c
Synchronize document titles and links based on configuring-playbook.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-26 21:28:31 +09:00
Suguru Hirahara
90cfdabb2b
Replace DOMAIN with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:02 +09:00
Suguru Hirahara
0261e247e3
Replace YOUR_DOMAIN with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:26:23 +09:00
Suguru Hirahara
282e8be07d
Use common sentences on documentation regarding installation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-13 03:38:48 +09:00
Suguru Hirahara
bf5373479b
Use common expression on documentation regarding playbook configuration
Overall the playbook uses the expression "Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:" with the heading "Adjusting the playbook configuration" for sections to explain what to be added as variables

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-12 20:59:15 +09:00
Slavi Pantaleev
1722e4bd83 Switch mautrix-slack double-puppeting method (shared secret auth -> appservice-double-puppet)
Since upgrading mautrix-slack (and pinning to v0.1.0) in e4b54c37fe,
we expect double-puppeting to require the new appservice double-puppeting method.

This commit switches the mautrix-slack bridge to it.
2024-08-17 19:03:38 +03:00
Stuart Mumford
8a471b97a1
Update configuring-playbook-bridge-mautrix-slack.md 2023-02-15 17:14:09 +00:00
Cody Wyatt Neiman
94474e387a
Fix mautrix slack doc typos and clarifications 2023-01-03 12:53:57 -05:00
Cody Wyatt Neiman
1c6ab4a1bc
Update documentation for mautrix slack 2023-01-03 12:33:09 -05:00
Cody Wyatt Neiman
784e5492d5
Add matrix-bridge-mautrix-slack role 2023-01-02 19:13:17 -05:00