Misleading documentation for `user_directory.search_all_users`

[babolivier]

The documentation says:

Defines whether to search all users visible to your HS when searching the user directory.

It does not make it clear that the users included in that cohort art the users visible by the homeserver at the time the search is performed, i.e. all users who share a room with a user from the homeserver at that time. As opposed to all users the homeserver has ever seen, regardless of whether they share a membership in a room.

While we're doing things around this part of the doc, it has a link to https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/background_updates.html#run which hasn't been linkified - it should probably be turned into a relative link (so that version prefixes in URLs carry over).

[exitflynn]

i'd love to work on this issue!
edit: apologies, anyone else feel free to work on this! 🤠

[babolivier]

Feel free to open a PR for it :)

[404-P4rziv4L]

If this issue is yet to be resolved, could I work on this?

[tjay27]

While we're doing things around this part of the doc, it has a link to https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/background_updates.html#run which hasn't been linkified - it should probably be turned into a relative link (so that version prefixes in URLs carry over).

At line 109 from background_updates.md

Here, the link to the user directory seems already relative.

Is there something extra I need to add for version prefix carry over? @clokep @babolivier

[DMRobertson]

Brendan was referring to

synapse/docs/usage/configuration/config_documentation.md

Lines 3474 to 3478 in 4eb2f4e

	These indexes are built the first time Synapse starts; admins can
	manually trigger a rebuild via the API following the instructions
	[for running background updates](../administration/admin_api/background_updates.md#run),
	set to true to return search results containing all known users, even if that
	user does not share a room with the requester.

, but I'm not sure what he meant by linkified. Looks like it's already a relative URL to me?

[tjay27]

Is this right?

If user_directory's search_all_users is

true - searches all users that share a room with the homeserver at that time.
false - search results will only contain users visible in public rooms and users sharing a room with the requester at that time

[tjay27]

@DMRobertson
It shows the URL there instead of for running background updates as mentioned in markdown.
That is what he meant by linkify

[DMRobertson]

Looks like #14003 fixed the link.