search-ui icon indicating copy to clipboard operation
search-ui copied to clipboard

Search UI Docs feedback and suggestions

Open JasonStoltz opened this issue 3 years ago • 6 comments

Have you had a chance to check out the new docs site for Search UI? You can find it here: https://docs.elastic.co/search-ui/overview.

We'd love to hear what you think. In particular, are there any guides you'd like to see us write up? We'd be happy to help you out there.

JasonStoltz avatar Jul 08 '22 20:07 JasonStoltz

actually i love the new docs they are great. Where or how do we give feedback i dont see the ability to comment or ask in the docs?

For example the filters for the product listing page show https://docs.elastic.co/search-ui/solutions/ecommerce/product-listing-page

// adding a filter to only show TVs filters: [{ field: "parent_category", values: ["TVs"] }]

But id does not show how to do a more complex nested any all query "filters": { "all": [ { "states": "California" }, { "world_heritage_site": "true" } ], "any": [ { "acres": { "from": 40000 } }, { "square_km": { "from": 500 } } ], "none": [ { "title": "Yosemite" } ] }

dankoz51 avatar Aug 09 '22 04:08 dankoz51

There's no inline way to give feedback, currently. Any feedback here is much appreciated.

Folks could also consider adding specific issues in the repository tagged with the docs tag.

Regarding the issue you mention, I think a simple link out from that section to the full filter syntax would be beneficial.

JasonStoltz avatar Aug 09 '22 11:08 JasonStoltz

Ok thanks

Where is the full filter syntax? It does not appear to work with the full one documented in the api.

On Tue, Aug 9, 2022 at 6:57 AM Jason Stoltzfus @.***> wrote:

There's no inline way to give feedback, currently. Any feedback here is much appreciated.

Folks could also consider adding specific issues in the repository tagged with the docs tag.

Regarding the issue you mention, I think a simple link out from that section to the full filter syntax would be beneficial.

— Reply to this email directly, view it on GitHub https://github.com/elastic/search-ui/issues/792#issuecomment-1209285918, or unsubscribe https://github.com/notifications/unsubscribe-auth/AASCB44X4ODTVHD6IEQ3IFTVYJBULANCNFSM53CB3M7A . You are receiving this because you commented.Message ID: @.***>

-- Sent from Gmail Mobile

dankoz51 avatar Aug 09 '22 12:08 dankoz51

What specifically isn't working? The type is documented here: https://docs.elastic.co/search-ui/api/core/actions#filtervalue--filtertype-types. More detail can be found here: https://www.elastic.co/guide/en/app-search/current/filters.html. If something isn't working there, create a separate issue and we can continue the conversation there.

JasonStoltz avatar Aug 09 '22 12:08 JasonStoltz

So the formats are a bit different from the types you sent used in the config filters and the app search filters.

I have a very complex nested query filter that i can get working in the api call like so (small example, its gets more complex)

{ "all": [ { "pattern": "6x6" }, { "core": { "from": 78.1, "to": 900 } } ] , "any": [ { "all": [ { "size": [ "20x10", "10x4" ] }, { "space": { "from": 10, "to": 35 } } ] } ], .......etc }

But the types from the filtertype I can get the initial part working

filters : [{field: 'pattern', values: ["6x6"]}, {field:'core', values: [{name: "core", from: 78.1, to: 900}]}, ????? ],

I am at a loss on how to get my working API query above into the filtertype format

What was not working was directly using the API filter format as that is not typed correctly (where its starts with any / all) which is expected as the type is different

Let me know where I should post this as it's probably not appropriate here.

Dan

On Tue, Aug 9, 2022 at 7:10 AM Jason Stoltzfus @.***> wrote:

What specifically isn't working? The type is documented here: https://docs.elastic.co/search-ui/api/core/actions#filtervalue--filtertype-types. More detail can be found here: https://www.elastic.co/guide/en/app-search/current/filters.html. If something isn't working there, create a separate issue and we can continue the conversation there.

— Reply to this email directly, view it on GitHub https://github.com/elastic/search-ui/issues/792#issuecomment-1209298326, or unsubscribe https://github.com/notifications/unsubscribe-auth/AASCB4Z2YIVPYZAH5CE73XDVYJDCFANCNFSM53CB3M7A . You are receiving this because you commented.Message ID: @.***>

-- -Dan Kozlowski Schedule a meeting here https://calendly.com/daniel-kozlowski/30min

Xumulus https://xumulus.com - m 773-230-2572 Customers love us on Clutch.co https://clutch.co/profile/xumulus

dankoz51 avatar Aug 09 '22 15:08 dankoz51

I've been working on React Native app so am using the SearchDriver from search-ui and app search connector as the other packages with providers are using DOM history etc.

My feedback would be to include some links to docs where I can learn more about the inner workings whats going on, for example addFilter takes a few arguments, the first two are self explanatory but all | any | none doesn't mean anything to me and I'm not sure where to get those answers?

I think there's a lot of assumed knowledge in the docs which as a reader I always find quite frustrating although I get the feeling that app search is meant to as easily accessible as possible without much prior knowledge? Once I start to come up against issues I'm not sure where to turn to.

omonk avatar Aug 16 '22 15:08 omonk