Skip to content

docs: rewrite user searchability page with consistent names - #5578

Open
mastaab wants to merge 1 commit into
developfrom
docs/searchability-naming
Open

mastaab wants to merge 1 commit into
developfrom
docs/searchability-naming

Conversation

@mastaab

@mastaab mastaab commented Sep 30, 2026

Copy link
Copy Markdown
Contributor

The page mixed API names, configuration keys and Haskell constructor names for the same settings, and used searchVisibility for the team search visibility value although that is the name of the team feature that only allows an admin to change it.

Use the API and configuration names throughout, with a mapping table to the code names at the end. Also:

  • state that the team search visibility does not affect exact-handle search
  • state that teamSearchVisibility sets the default of the feature, not a default search visibility
  • describe setSearchSameTeamOnly as a query-time override that also restricts exact-handle search and handle lookup
  • document the team role (partner cannot search), per-user searchability, searchers without a team, and POST /list-users / HEAD /handles

Checklist

  • Add a new entry in an appropriate subdirectory of changelog.d
  • Read and follow the PR guidelines

@mastaab
mastaab requested review from a team as code owners September 30, 2026 20:29
@zebot zebot added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Sep 30, 2026
The page mixed API names, configuration keys and Haskell constructor names
for the same settings, and used `searchVisibility` for the team search
visibility value although that is the name of the team feature that only
allows an admin to change it.

Use the API and configuration names throughout, with a mapping table to the
code names at the end. Also:

- state that the team search visibility does not affect exact-handle search
- state that `teamSearchVisibility` sets the default of the feature, not a
  default search visibility
- describe `setSearchSameTeamOnly` as a query-time override that also
  restricts exact-handle search and handle lookup
- document the team role (`partner` cannot search), per-user searchability,
  searchers without a team, and `POST /list-users` / `HEAD /handles`
@mastaab
mastaab force-pushed the docs/searchability-naming branch from 3d44faf to 132675c Compare September 30, 2026 20:35

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants