docbrown/docs/admin/admin-search.md
Ridhwana 449723d8c7
[15-min-fix] Remove/Update the last of the admin hardcoded paths (#13681)
* chore: hardcoded paths

* hardcoded docs path

* Update docs/admin/admin-search.md

Co-authored-by: rhymes <github@rhymes.dev>

Co-authored-by: rhymes <github@rhymes.dev>
2021-05-06 15:12:06 +02:00

24 lines
1 KiB
Markdown

---
title: Admin Search
---
# Admin Search
For admin views that need to take advantage of searching and filtering, we've
chosen to use [Ransack][ransack].
Ransack is a Ruby gem that makes searching relatively painless. It has excellent
documentation, but if you're looking for an example of how it's being used on
Forem, we've implemented it to help searching and sorting user reports.
The view responsible for managing user reports can be found at
`/admin/moderation/reports` and Ransack can be seen in use on the
index action of the [`admin/feedback_messages_controller`][feedback_messages].
For Forem, Ransack is being used exclusively in admin, for search problems in
other parts of the app we use [PostgreSQL Full Text Search][postgres_fts].
[feedback_messages]:
https://github.com/forem/forem/blob/4e41e4a2ac893fa2a6c36990cfe475858ffb086a/app/controllers/admin/feedback_messages_controller.rb#L4
[ransack]: https://github.com/activerecord-hackery/ransack
[postgres_fts]: https://www.postgresql.org/docs/11/textsearch.html