From bfa8902a25336e11754e6fa5f5a083e1b0c88300 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Wed, 25 Dec 2024 21:56:57 -0500 Subject: [PATCH] Update docs/configuring-playbook-rageshake.md: adopt the common instruction Based on docs/configuring-playbook-sygnal.md regarding the notification about necessity of the service. Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-rageshake.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-rageshake.md b/docs/configuring-playbook-rageshake.md index 88bc3fd61..8847811ef 100644 --- a/docs/configuring-playbook-rageshake.md +++ b/docs/configuring-playbook-rageshake.md @@ -2,7 +2,9 @@ The playbook can install and configure the [rageshake](https://github.com/matrix-org/rageshake) bug report server for you. -This is useful if you're developing your own applications and would like to collect bug reports for them. +See the project's [documentation](https://github.com/matrix-org/rageshake/blob/main/README.md) to learn what it does and why it might be useful to you. + +**Note**: most people don't need to install rageshake to collect bug reports. This component is only useful to people who develop/build their own Matrix client applications themselves. ## Adjusting the playbook configuration @@ -64,4 +66,4 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju ## Usage -Refer to the [rageshake documentation](https://github.com/matrix-org/rageshake) for available APIs, etc. +Refer to the project's [documentation](https://github.com/matrix-org/rageshake/blob/main/README.md) for available APIs, etc.