deploy: 2aad0ae57fc4fa4a57b2764065687e00b99de82a

1 files changed, 17 insertions, 11 deletions

diff --git a/develop/upgrade.html b/develop/upgrade.html
index 7199c94808..357618346a 100644
--- a/develop/upgrade.html
+++ b/develop/upgrade.html
@@ -239,23 +239,29 @@ Device IDs are unaffected, as these are necessary to facilitate end-to-end encry
 <p>To re-enable this functionality, set the
 <a href="https://matrix-org.github.io/synapse/v1.59/usage/configuration/config_documentation.html#federation"><code>allow_device_name_lookup_over_federation</code></a>
 homeserver config option to <code>true</code>.</p>
-<h2 id="deprecation-of-the-synapseappappservice-worker-application-type"><a class="header" href="#deprecation-of-the-synapseappappservice-worker-application-type">Deprecation of the <code>synapse.app.appservice</code> worker application type</a></h2>
+<h2 id="deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types"><a class="header" href="#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types">Deprecation of the <code>synapse.app.appservice</code> and <code>synapse.app.user_dir</code> worker application types</a></h2>
 <p>The <code>synapse.app.appservice</code> worker application type allowed you to configure a
 single worker to use to notify application services of new events, as long
-as this functionality was disabled on the main process with <code>notify_appservices: False</code>.</p>
+as this functionality was disabled on the main process with <code>notify_appservices: False</code>.
+Further, the <code>synapse.app.user_dir</code> worker application type allowed you to configure
+a single worker to be responsible for updating the user directory, as long as this
+was disabled on the main process with <code>update_user_directory: False</code>.</p>
 <p>To unify Synapse's worker types, the <code>synapse.app.appservice</code> worker application
-type and the <code>notify_appservices</code> configuration option have been deprecated.</p>
-<p>To get the same functionality, it's now recommended that the <code>synapse.app.generic_worker</code>
-worker application type is used and that the <code>notify_appservices_from_worker</code> option
-is set to the name of a worker.</p>
-<p>For the time being, <code>notify_appservices_from_worker</code> can be used alongside
-<code>synapse.app.appservice</code> and <code>notify_appservices</code> to make it easier to transition
-between the two configurations, however please note that:</p>
+type and the <code>notify_appservices</code> configuration option have been deprecated.
+The <code>synapse.app.user_dir</code> worker application type and <code>update_user_directory</code>
+configuration option have also been deprecated.</p>
+<p>To get the same functionality as was provided by the deprecated options, it's now recommended that the <code>synapse.app.generic_worker</code>
+worker application type is used and that the <code>notify_appservices_from_worker</code> and/or
+<code>update_user_directory_from_worker</code> options are set to the name of a worker.</p>
+<p>For the time being, the old options can be used alongside the new options to make
+it easier to transition between the two configurations, however please note that:</p>
 <ul>
 <li>the options must not contradict each other (otherwise Synapse won't start); and</li>
-<li>the <code>notify_appservices</code> option will be removed in a future release of Synapse.</li>
+<li>the <code>notify_appservices</code> and <code>update_user_directory</code> options will be removed in a future release of Synapse.</li>
 </ul>
-<p>Please see <a href="workers.html#notifying-application-services">the relevant section of the worker documentation</a> for more information.</p>
+<p>Please see the <a href="workers.html#notifying-application-services"><em>Notifying Application Services</em></a> and
+<a href="workers.html#updating-the-user-directory"><em>Updating the User Directory</em></a> sections of the worker
+documentation for more information.</p>
 <h1 id="upgrading-to-v1580"><a class="header" href="#upgrading-to-v1580">Upgrading to v1.58.0</a></h1>
 <h2 id="groupscommunities-feature-has-been-disabled-by-default"><a class="header" href="#groupscommunities-feature-has-been-disabled-by-default">Groups/communities feature has been disabled by default</a></h2>
 <p>The non-standard groups/communities feature in Synapse has been disabled by default