Misleading documentation for user_directory.search_all_users #13852

Activity

1. babolivier

   added

   A-Docsthings relating to the documentationthings relating to the documentation

   S-MinorBlocks non-critical functionality, workarounds exist.Blocks non-critical functionality, workarounds exist.

   T-TaskRefactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.

   O-OccasionalAffects or can be seen by some users regularly or most users rarelyAffects or can be seen by some users regularly or most users rarely

   good first issueGood for newcomersGood for newcomers

   on Sep 20, 2022
2. exitflynn commented on Sep 21, 2022

   

   exitflynn

   on Sep 21, 2022

   Last edited by exitflynn

   Contributor

   More actions

   i'd love to work on this issue!
   edit: apologies, anyone else feel free to work on this! 🤠
3. babolivier commented on Sep 22, 2022

   

   babolivier

   on Sep 22, 2022

   Last edited by babolivier

   ContributorAuthor

   More actions

   Feel free to open a PR for it :)
4. 404-P4rziv4L commented on Oct 27, 2022

   

   404-P4rziv4L

   on Oct 27, 2022

   More actions

   If this issue is yet to be resolved, could I work on this?
5. tjay27 commented on Jan 9, 2023

   

   tjay27

   on Jan 9, 2023

   Contributor

   More actions

   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
6. DMRobertson commented on Jan 9, 2023

   

   DMRobertson

   on Jan 9, 2023

   Contributor

   More actions

   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?

   👍React with 👍1Reacted by Tejaswini Gurram
7. tjay27 commented on Jan 9, 2023

   

   tjay27

   on Jan 9, 2023

   Contributor

   More actions

   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
8. tjay27 commented on Jan 9, 2023

   

   tjay27

   on Jan 9, 2023

   Contributor

   More actions

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

   
9. DMRobertson commented on Jan 9, 2023

   

   DMRobertson

   on Jan 9, 2023

   Contributor

   More actions

   Looks like #14003 fixed the link.

   👍React with 👍1Reacted by Tejaswini Gurram
10. erikjohnston

    closed this as completedin #14818on Jan 13, 2023
11. erikjohnston

    added a commit that references this issue on Jan 13, 2023

    Update misleading documentation ` user_directory.search_all_users ` (#…

    ...

    This issue will close once commit 1416096 is merged into the 'develop' branch.

    1416096