Skip to content

Commit

Permalink
Update docs: small edits for consistency
Browse files Browse the repository at this point in the history
The common strings are: "to learn what it does and why it might be useful to you."

Signed-off-by: Suguru Hirahara <[email protected]>
  • Loading branch information
Suguru Hirahara committed Dec 17, 2024
1 parent 2c6dfea commit f3cf8a8
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/configuring-playbook-alertmanager-receiver.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The playbook can install and configure the [matrix-alertmanager-receiver](https://github.com/metio/matrix-alertmanager-receiver) service for you. It's a [client](https://prometheus.io/docs/alerting/latest/clients/) for Prometheus' [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/), allowing you to deliver alerts to Matrix rooms.

See the project's [documentation](https://github.com/metio/matrix-alertmanager-receiver) to learn more about what this component does and why it might be useful to you.
See the project's [documentation](https://github.com/metio/matrix-alertmanager-receiver) to learn what it does and why it might be useful to you.

At the moment, **setting up this service's bot requires some manual actions** as described below in [Account and room preparation](#account-and-room-preparation).

Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-honoroit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The playbook can install and configure [Honoroit](https://github.com/etkecc/hono

It's a bot you can use to setup **your own helpdesk on matrix**

See the project's [documentation](https://github.com/etkecc/honoroit#how-it-looks-like) to learn what it does with screenshots and why it might be useful to you.
See the project's [documentation](https://github.com/etkecc/honoroit#how-it-looks-like) to learn what it does and why it might be useful to you.

## Adjusting the playbook configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bridge-hookshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The playbook can install and configure [matrix-hookshot](https://github.com/matr

Hookshot can bridge [Webhooks](https://en.wikipedia.org/wiki/Webhook) from software project management services such as GitHub, GitLab, JIRA, and Figma, as well as generic webhooks.

See the project's [documentation](https://matrix-org.github.io/matrix-hookshot/latest/hookshot.html) to learn what it does in detail and why it might be useful to you.
See the project's [documentation](https://matrix-org.github.io/matrix-hookshot/latest/hookshot.html) to learn what it does and why it might be useful to you.

**Note**: the playbook also supports [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md), which however was deprecated by its author.

Expand Down

0 comments on commit f3cf8a8

Please sign in to comment.