From 5cae9158e67babe0553bc356802495a068222685 Mon Sep 17 00:00:00 2001
From: "Olivier Wilkinson (reivilibre)" <oliverw@matrix.org>
Date: Tue, 23 May 2023 11:13:38 +0100
Subject: Tweak changelog and upgrade notes

---
 docs/upgrade.md | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

(limited to 'docs')

diff --git a/docs/upgrade.md b/docs/upgrade.md
index 0625de8afb..af999dd91f 100644
--- a/docs/upgrade.md
+++ b/docs/upgrade.md
@@ -92,15 +92,22 @@ process, for example:
 
 ## Deprecation of `worker_replication_*` configuration settings
 
-When using workers, 
+When using workers,
+
 * `worker_replication_host`
 * `worker_replication_http_port`
 * `worker_replication_http_tls`
  
-can now be removed from individual worker YAML configuration ***if*** you add the main process to the `instance_map` in the shared YAML configuration,
-using the name `main`.
+should now be removed from individual worker YAML configurations and the main process should instead be added to the `instance_map`
+in the shared YAML configuration, using the name `main`.
+
+The old `worker_replication_*` settings are now considered deprecated and are expected to be removed in Synapse v1.88.0.
+
+
+### Example change
+
+#### Before:
 
-### Before:
 Shared YAML
 ```yaml
 instance_map:
@@ -109,6 +116,7 @@ instance_map:
     port: 5678
     tls: false
 ```
+
 Worker YAML
 ```yaml
 worker_app: synapse.app.generic_worker
@@ -130,7 +138,10 @@ worker_listeners:
 
 worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml
 ```
-### After:
+
+
+#### After:
+
 Shared YAML
 ```yaml
 instance_map:
@@ -143,6 +154,7 @@ instance_map:
     port: 5678
     tls: false
 ```
+
 Worker YAML
 ```yaml
 worker_app: synapse.app.generic_worker
@@ -165,7 +177,6 @@ Notes:
 * `tls` is optional but mirrors the functionality of `worker_replication_http_tls`
 
 
-
 # Upgrading to v1.81.0
 
 ## Application service path & authentication deprecations
-- 
cgit 1.4.1