From a6b32bad77f46ad27817382490653118cf1c9ff9 Mon Sep 17 00:00:00 2001 From: Brendan Abolivier Date: Fri, 1 May 2020 13:42:35 +0200 Subject: Make it clearer that #synapse:matrix.org is our support channel (#7379) This PR moves the "support is in #synapse:matrix.org" in the bug report template outside of the comment as some people seem to ignore what's in the comments, and phrase it a bit more like the support request template. It also adds a default issue template that says the same thing. It's also adding a notice about the security disclosure to both the default template and the bug report one. It also adds a badge to the top of the README with an alt text saying about the same message if the badge doesn't load (e.g. if matrix.org is slow). Fixes #6826 --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 4db7d17e94..49fca2aba6 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,11 @@ +================ +Synapse |shield| +================ + +.. |shield| image:: https://img.shields.io/matrix/synapse:matrix.org?label=support&logo=matrix + :alt: (get support on #synapse:matrix.org) + :target: https://matrix.to/#/#synapse:matrix.org + .. contents:: Introduction -- cgit 1.5.1 From cb6fd280af4858e2ad5ff2d68b56a5e0021395ea Mon Sep 17 00:00:00 2001 From: Brendan Abolivier Date: Fri, 1 May 2020 17:27:22 +0200 Subject: Add a section about support to the top of the README (#7392) Continuation of #7379 Adds a section in the README telling people to go to #synapse:matrix.org instead of using github issues. I'm not entirely sure about placing it above the install section but then people are likely to first seek support when installing (if something goes boom), and it's probably better to have it as high as possible anyway so people actually see it. --- README.rst | 11 +++++++++++ changelog.d/7392.doc | 1 + 2 files changed, 12 insertions(+) create mode 100644 changelog.d/7392.doc (limited to 'README.rst') diff --git a/README.rst b/README.rst index 49fca2aba6..677689bc03 100644 --- a/README.rst +++ b/README.rst @@ -85,6 +85,17 @@ Thanks for using Matrix! [1] End-to-end encryption is currently in beta: `blog post `_. +Support +======= + +For support installing or managing Synapse, please join |room|_ (from a matrix.org +account if necessary) and ask questions there. We do not use GitHub issues for +support requests, only for bug reports and feature requests. + +.. |room| replace:: ``#synapse:matrix.org`` +.. _room: https://matrix.to/#/#synapse:matrix.org + + Synapse Installation ==================== diff --git a/changelog.d/7392.doc b/changelog.d/7392.doc new file mode 100644 index 0000000000..29daa19f90 --- /dev/null +++ b/changelog.d/7392.doc @@ -0,0 +1 @@ +Spell it in an even more obvious way that the support channel for Synapse is `#synapse:matrix.org`. -- cgit 1.5.1