Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit a888cbd

Browse files
erikjohnstonanoadragon453clokep
authored
Add deprecation policy doc (#9723)
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
1 parent fc8695d commit a888cbd

File tree

4 files changed

+46
-2
lines changed

4 files changed

+46
-2
lines changed

INSTALL.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ There are 3 steps to follow under **Installation Instructions**.
3838
- [URL previews](#url-previews)
3939
- [Troubleshooting Installation](#troubleshooting-installation)
4040

41+
4142
## Choosing your server name
4243

4344
It is important to choose the name for your server before you install Synapse,
@@ -542,7 +543,7 @@ Alternatively, you can do so from the command line. This can be done as follows:
542543
register_new_matrix_user -c homeserver.yaml http://localhost:8008
543544
```
544545

545-
This will prompt you to add details for the new user, and will then connect to
546+
This will prompt you to add details for the new user, and will then connect to
546547
the running Synapse to create the new user. For example:
547548
```
548549
New user localpart: erikj

README.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,15 @@ Testing with SyTest is recommended for verifying that changes related to the
314314
Client-Server API are functioning correctly. See the `installation instructions
315315
<https://github.com/matrix-org/sytest#installing>`_ for details.
316316

317+
318+
Platform dependencies
319+
=====================
320+
321+
Synapse uses a number of platform dependencies such as Python and PostgreSQL,
322+
and aims to follow supported upstream versions. See the
323+
`<docs/deprecation_policy.md>`_ document for more details.
324+
325+
317326
Troubleshooting
318327
===============
319328

@@ -389,7 +398,7 @@ likely cause. The misbehavior can be worked around by setting
389398
People can't accept room invitations from me
390399
--------------------------------------------
391400

392-
The typical failure mode here is that you send an invitation to someone
401+
The typical failure mode here is that you send an invitation to someone
393402
to join a room or direct chat, but when they go to accept it, they get an
394403
error (typically along the lines of "Invalid signature"). They might see
395404
something like the following in their logs::

changelog.d/9723.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add a document describing the deprecation policy for platform dependencies.

docs/deprecation_policy.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Deprecation Policy for Platform Dependencies
2+
============================================
3+
4+
Synapse has a number of platform dependencies, including Python and PostgreSQL.
5+
This document outlines the policy towards which versions we support, and when we
6+
drop support for versions in the future.
7+
8+
9+
Policy
10+
------
11+
12+
Synapse follows the upstream support life cycles for Python and PostgreSQL,
13+
i.e. when a version reaches End of Life Synapse will withdraw support for that
14+
version in future releases.
15+
16+
Details on the upstream support life cycles for Python and PostgreSQL are
17+
documented at https://endoflife.date/python and
18+
https://endoflife.date/postgresql.
19+
20+
21+
Context
22+
-------
23+
24+
It is important for system admins to have a clear understanding of the platform
25+
requirements of Synapse and its deprecation policies so that they can
26+
effectively plan upgrading their infrastructure ahead of time. This is
27+
especially important in contexts where upgrading the infrastructure requires
28+
auditing and approval from a security team, or where otherwise upgrading is a
29+
long process.
30+
31+
By following the upstream support life cycles Synapse can ensure that its
32+
dependencies continue to get security patches, while not requiring system admins
33+
to constantly update their platform dependencies to the latest versions.

0 commit comments

Comments
 (0)