RocketChat / RocketChat/Rocket.Chat
Documentation on UI option for Accounts_SearchFields should be enhanced
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 46.1k
- Forks
- 13.9k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 130
Description
We wanted to include the email address into our user search and found the option in the UI Fields to Consider in Search, but it took a while to find the correct entry. The only hint on how to reference the email was in a comment on another issue. Since the right way to refer to the email address is entering emails.address, which is not quite trivial, that should be documented somewhere and maybe enriched with all other available options.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the UI option named “Fields to Consider in Search” and review the linked comment on issue 9809 for the existing explanation of emails.address. Locate the documentation for Accounts_SearchFields, then document the email syntax and, if available, the other searchable fields. Done means users can find and correctly configure the email address without relying on the issue comment.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100