search

archesproject / arches-docs

official repo for Arches documentation
https://arches.readthedocs.io
9 stars 21 forks source link

Search m #335

Closed ekansa closed 1 year ago

ekansa commented 1 year ago

brief description of changes

I added some documentation about search features, including use of the "negation" (exclude) feature, some special text pattern matching, and some topics in Advanced search. We didn't have anything about this topic until now, so I thought it would be a good addition.

issues addressed

https://github.com/archesproject/arches-docs/issues/225

further comments

Search is a big topic. We may want to document more aspects of search incrementally with multiple pull requests. This initial PR should document the essentials first, then we can add more nuance and details later.

You can preview the search documentation added in this PR here: https://arches.readthedocs.io/en/search_m/user-guide/searching/

Thanks @apeters for the pointers about the search operators!

This box must be checked

This box should be checked

This box should only be checked you intend to follow through on it (we can do it on our end too)

mradamcox commented 1 year ago

@ekansa Glad to see this, it looks really good overall, as you say, a good start. A couple notes though:

Ticket #222 that you referenced is actually geared toward documenting how to make custom search filters a la "extensions", not how to use the default search filters that come with Arches. The ticket you probably meant is #225. Looking at the latter, perhaps you it wouldn't be to difficult too much more work to address #185 in this PR as well?

Also, just wanted to make sure you're aware of the in-app help available in the Arches Search interface (? button in top-right). There is a good bit of information in there on the different default search tools that are available, but it hasn't been updated for a while, so worth a lookover before copying into these docs. That template is here: https://github.com/archesproject/arches/blob/master/arches/app/templates/help/search-help.htm, and, this is a good reminder that there is a fair bit of information in those help templates that may not actually be in the User Guide. Worth looking through for sure.