From a61767143a56a4f691aa91fc784c0d2f4385d608 Mon Sep 17 00:00:00 2001 From: Maximilian Kratz Date: Fri, 1 Oct 2021 17:22:51 +0200 Subject: [PATCH 1/4] Removed "reference" wording according Synapse homeserver --- README.rst | 9 ++++----- docs/README.md | 7 ++++--- docs/welcome_and_overview.md | 5 +++-- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 524a3a5142ee..95eec1dd8614 100644 --- a/README.rst +++ b/README.rst @@ -55,11 +55,10 @@ solutions. The hope is for Matrix to act as the building blocks for a new generation of fully open and interoperable messaging and VoIP apps for the internet. -Synapse is a reference "homeserver" implementation of Matrix from the core -development team at matrix.org, written in Python/Twisted. It is intended to -showcase the concept of Matrix and let folks see the spec in the context of a -codebase and let you run your own homeserver and generally help bootstrap the -ecosystem. +Synapse is a Matrix "homeserver" implementation developed by the matrix.org core +team, written in Python 3/Twisted. It is intended to showcase the concept of Matrix +and let folks see the spec in the context of a codebase and let you run your own +homeserver and generally help bootstrap the ecosystem. In Matrix, every user runs one or more Matrix clients, which connect through to a Matrix homeserver. The homeserver stores all their personal chat history and diff --git a/docs/README.md b/docs/README.md index e113f55d2a70..2f6bbd3b6f7e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,9 +6,10 @@ Please update any links to point to the new website instead. ## About This directory currently holds a series of markdown files documenting how to install, use -and develop Synapse, the reference Matrix homeserver. The documentation is readable directly -from this repository, but it is recommended to instead browse through the -[website](https://matrix-org.github.io/synapse) for easier discoverability. +and develop Synapse, a Matrix "homeserver" implementation developed by the matrix.org core +team. The documentation is readable directly from this repository, but it is recommended +to instead browse through the [website](https://matrix-org.github.io/synapse) for easier +discoverability. ## Adding to the documentation diff --git a/docs/welcome_and_overview.md b/docs/welcome_and_overview.md index 30e75984d1ef..98402561ac28 100644 --- a/docs/welcome_and_overview.md +++ b/docs/welcome_and_overview.md @@ -1,4 +1,5 @@ # Introduction -Welcome to the documentation repository for Synapse, the reference -[Matrix](https://matrix.org) homeserver implementation. \ No newline at end of file +Welcome to the documentation repository for Synapse, a +[Matrix](https://matrix.org) implementation developed by the matrix.org core +team. From 464dcf80f097be9bcff0795ae0f0b69b2d68e9b3 Mon Sep 17 00:00:00 2001 From: Maximilian Kratz Date: Fri, 1 Oct 2021 17:35:06 +0200 Subject: [PATCH 2/4] Added changelog file --- changelog.d/10971.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/10971.doc diff --git a/changelog.d/10971.doc b/changelog.d/10971.doc new file mode 100644 index 000000000000..b4d7b1b9cc39 --- /dev/null +++ b/changelog.d/10971.doc @@ -0,0 +1 @@ +Changed wording ("reference homeserver") in Synapse repository documentation. From 3b9acca72adbce2c1010cffbd411ad44b99778dc Mon Sep 17 00:00:00 2001 From: Maximilian Kratz Date: Tue, 5 Oct 2021 14:57:56 +0200 Subject: [PATCH 3/4] Adapt changes to PR review and fix changelog --- README.rst | 4 +--- changelog.d/10971.doc | 2 +- docs/README.md | 7 +++---- docs/welcome_and_overview.md | 2 +- 4 files changed, 6 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 95eec1dd8614..63deb06eac2b 100644 --- a/README.rst +++ b/README.rst @@ -56,9 +56,7 @@ generation of fully open and interoperable messaging and VoIP apps for the internet. Synapse is a Matrix "homeserver" implementation developed by the matrix.org core -team, written in Python 3/Twisted. It is intended to showcase the concept of Matrix -and let folks see the spec in the context of a codebase and let you run your own -homeserver and generally help bootstrap the ecosystem. +team, written in Python 3/Twisted. In Matrix, every user runs one or more Matrix clients, which connect through to a Matrix homeserver. The homeserver stores all their personal chat history and diff --git a/changelog.d/10971.doc b/changelog.d/10971.doc index b4d7b1b9cc39..28f56fcde215 100644 --- a/changelog.d/10971.doc +++ b/changelog.d/10971.doc @@ -1 +1 @@ -Changed wording ("reference homeserver") in Synapse repository documentation. +Change wording ("reference homeserver") in Synapse repository documentation. diff --git a/docs/README.md b/docs/README.md index 2f6bbd3b6f7e..6d70f5afff18 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,10 +6,9 @@ Please update any links to point to the new website instead. ## About This directory currently holds a series of markdown files documenting how to install, use -and develop Synapse, a Matrix "homeserver" implementation developed by the matrix.org core -team. The documentation is readable directly from this repository, but it is recommended -to instead browse through the [website](https://matrix-org.github.io/synapse) for easier -discoverability. +and develop Synapse. The documentation is readable directly from this repository, but it is +recommended to instead browse through the [website](https://matrix-org.github.io/synapse) for +easier discoverability. ## Adding to the documentation diff --git a/docs/welcome_and_overview.md b/docs/welcome_and_overview.md index 98402561ac28..9882d9f15942 100644 --- a/docs/welcome_and_overview.md +++ b/docs/welcome_and_overview.md @@ -1,5 +1,5 @@ # Introduction Welcome to the documentation repository for Synapse, a -[Matrix](https://matrix.org) implementation developed by the matrix.org core +[Matrix](https://matrix.org) homeserver implementation developed by the matrix.org core team. From a63a21e8532aa96de1268622421b6df7ba3a85db Mon Sep 17 00:00:00 2001 From: Max Kratz Date: Wed, 6 Oct 2021 10:22:54 +0200 Subject: [PATCH 4/4] Update changelog.d/10971.doc Co-authored-by: David Robertson --- changelog.d/10971.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/10971.doc b/changelog.d/10971.doc index 28f56fcde215..cc6cfe416454 100644 --- a/changelog.d/10971.doc +++ b/changelog.d/10971.doc @@ -1 +1 @@ -Change wording ("reference homeserver") in Synapse repository documentation. +Change wording ("reference homeserver") in Synapse repository documentation. Contributed by @maxkratz.