Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Search UI Docs feedback and suggestions #792

Open
JasonStoltz opened this issue Jul 8, 2022 · 6 comments
Open

Search UI Docs feedback and suggestions #792

JasonStoltz opened this issue Jul 8, 2022 · 6 comments
Labels

Comments

@JasonStoltz
Copy link
Member

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 JasonStoltz pinned this issue Jul 8, 2022
@dankoz51
Copy link

dankoz51 commented Aug 9, 2022

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" }
]
}

@JasonStoltz
Copy link
Member Author

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.

@dankoz51
Copy link

dankoz51 commented Aug 9, 2022 via email

@JasonStoltz
Copy link
Member Author

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.

@dankoz51
Copy link

dankoz51 commented Aug 9, 2022 via email

@omonk
Copy link
Contributor

omonk commented Aug 16, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants