Skip to content

Commit 5ef5f8d

Browse files
Restructure Search UI landing page (#1628)
[Preview](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1628/solutions/search/site-or-app/search-ui) This PR restructures the Search UI Documentation landing page to improve clarity, navigability, and alignment with documentation best practices. This restructure is a second PR toward eliminating duplication between the two main Search UI documentation pages: https://www.elastic.co/docs/reference/search-ui https://www.elastic.co/docs/solutions/search/site-or-app/search-ui Also: - Added information on Serverless being compatible with Search UI but not with CORS Connected to - elastic/search-ui#1169 - elastic/developer-docs-team#295 --------- Co-authored-by: shainaraskas <[email protected]>
1 parent 72c223e commit 5ef5f8d

File tree

2 files changed

+17
-115
lines changed

2 files changed

+17
-115
lines changed

deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ The information below reflects our strategic goals, plans and objectives and inc
3434
| **User management** | Elastic Cloud-managed and deployment-local users | Elastic Cloud-managed users only. Serverless users are managed at the organization level with SAML authentication support. |
3535
| **Backups** | User-managed with Snapshot & Restore | Automatically backed up by Elastic |
3636
| **Solutions** | Full {{stack}} per deployment | Single solution per project |
37+
| **Cross-origin resource sharing (CORS)** | Supported | Not available. Browser-based applications must route requests through a backend proxy server. |
3738

3839
In Serverless, Elastic automatically manages:
3940
* Cluster scaling and optimization

solutions/search/site-or-app/search-ui.md

Lines changed: 16 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -12,132 +12,33 @@ products:
1212

1313
# What is Search UI? [overview]
1414

15-
A JavaScript library for the fast development of modern, engaging search experiences with [Elastic](https://www.elastic.co/). Get up and running quickly without re-inventing the wheel.
15+
Search UI is a JavaScript library from [Elastic](https://www.elastic.co/). It helps you create modern and customizable search experiences. You can use it with Elasticsearch or other search APIs. It helps developers build complete search interfaces quickly, with minimal boilerplate.
1616

17+
As a headless library, Search UI separates logic from presentation. You can use it with React, vanilla JavaScript, or any front-end framework. You can use built-in React components for quick development. Or, you can create your own from the ground up.
1718

18-
## Features 👍 [overview-features]
19+
Search UI supports advanced capabilities like customizable query behavior, smart URL handling (capturing filters, paging, and queries in the URL), and flexible backend integration through connectors. It works seamlessly with Elasticsearch and also supports custom backends via custom connectors.
1920

20-
* **You know, for search** - Maintained by [Elastic](https://elastic.co), the team behind Elasticsearch.
21-
* **Speedy Implementation** - Build a complete search experience with a few lines of code.
22-
* **Customizable** - Tune the components, markup, styles, and behaviors to your liking.
23-
* **Smart URLs** - Searches, paging, filtering, and more, are captured in the URL for direct result linking.
24-
* **Flexible front-end** - Not just for React. Use with any JavaScript library, even vanilla JavaScript.
25-
* **Flexible back-end** - Use it with Elasticsearch, Elastic Enterprise Search, or any other search API.
2621
:::{important}
2722
Enterprise Search is not available in {{stack}} 9.0+.
2823
:::
2924

25+
## Get started
26+
* [Reference documentation](search-ui://reference/index.md): API docs, tutorials, and usage guides
27+
* [Quickstart tutorials](search-ui://reference/tutorials.md)
28+
* [Ecommerce examples](search-ui://reference/ecommerce.md)
29+
* [Basic usage](search-ui://reference/basic-usage.md)
30+
* [API reference](search-ui://reference/api-reference.md)
31+
* [GitHub repository](https://github.com/elastic/search-ui): Source code, examples, and issue tracking
3032

31-
## Live demos 👀 [overview-live-demos]
32-
33+
## Live demos [overview-live-demos]
3334

3435
### Connectors [overview-connectors]
3536

36-
* [Elasticsearch](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/elasticsearch&file=/src/pages/elasticsearch/index.js)
37-
* [Elastic Site Search (Swiftype)](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/site-search&file=/src/pages/site-search/index.js)
38-
* ⚠️ DEPRECATED. [Elastic App Search](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/app-search&file=/src/pages/app-search/index.js)
39-
* ⚠️ DEPRECATED. [Elastic Workplace Search](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/workplace-search&file=/src/pages/workplace-search/index.js)
40-
37+
- [Elasticsearch](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/elasticsearch&file=/src/pages/elasticsearch/index.js)
38+
- [Elastic Site Search (Swiftype)](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/site-search&file=/src/pages/site-search/index.js)
4139

4240
### Examples [overview-examples]
4341

44-
* [Search as you type](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/search-as-you-type&file=/src/pages/search-as-you-type/index.js)
45-
* [Search bar in header](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/search-bar-in-header&file=/src/pages/search-bar-in-header/index.js)
46-
* [Customizing Styles and Components](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/customizing-styles-and-html&file=/src/pages/customizing-styles-and-html/index.js)
47-
48-
49-
## Get Started 🌟 [overview-get-started]
50-
51-
52-
### Installation [overview-installation]
53-
54-
```sh
55-
npm install @elastic/search-ui @elastic/react-search-ui @elastic/react-search-ui-views
56-
# or
57-
yarn add @elastic/search-ui @elastic/react-search-ui @elastic/react-search-ui-views
58-
```
59-
60-
61-
### Tutorials [overview-tutorials]
62-
63-
Get started quickly with Search UI and your favorite Elastic product by following one of the tutorials below:
64-
65-
* [Elasticsearch](search-ui://reference/tutorials-elasticsearch.md)
66-
* [Elastic App Search (⚠️ DEPRECATED)](search-ui://reference/tutorials-app-search.md)
67-
* [Elastic Workplace Search (⚠️ DEPRECATED)](search-ui://reference/tutorials-workplace-search.md)
68-
69-
70-
## Use Cases 🛠️ [overview-use-cases]
71-
72-
73-
### Ecommerce [overview-ecommerce]
74-
75-
Search UI works great in the ecommerce use-case. Check out our [ecommerce guide](search-ui://reference/ecommerce.md) that includes demo and code examples, as well as general guidance for ecommerce search.
76-
77-
78-
## FAQ 🔮 [overview-faq]
79-
80-
81-
### Is Search UI only for React? [overview-is-search-ui-only-for-react]
82-
83-
Search UI is "headless". You can use vanilla JavaScript or write support for it into any JavaScript framework.
84-
85-
[Read about the search-ui package](https://github.com/elastic/search-ui/tree/main/packages/search-ui) for more information, or check out the [Vue.js Example](https://github.com/elastic/vue-search-ui-demo).
86-
87-
88-
### Can I use my own styles? [overview-can-i-use-my-own-styles]
89-
90-
You can!
91-
92-
Read the [Custom Styles and Layout Guide](search-ui://reference/basic-usage.md) to learn more, or check out the [Seattle Indies Expo Demo](https://github.com/elastic/seattle-indies-expo-search).
93-
94-
95-
### Can I build my own Components? [overview-can-i-build-my-own-components]
96-
97-
Yes! Absolutely.
98-
99-
Check out the [Build Your Own Component Guide](search-ui://reference/guides-creating-own-components.md).
100-
101-
102-
### Does Search UI only work with App Search? [overview-does-search-ui-only-work-with-app-search]
103-
104-
Nope! We do have two first party connectors: Site Search and App Search.
105-
106-
But Search UI is headless. You can use *any* Search API.
107-
108-
Read the [Building a custom connector](search-ui://reference/guides-building-custom-connector.md) to learn more about building your own connector for your API.
109-
110-
111-
### How do I use this with Elasticsearch? [overview-how-do-i-use-this-with-elasticsearch]
112-
113-
Read the [Elasticsearch Connector](search-ui://reference/api-connectors-elasticsearch.md) docs.
114-
115-
116-
### Where do I report issues with the Search UI? [overview-where-do-i-report-issues-with-the-search-ui]
117-
118-
If something is not working as expected, open an [issue](https://github.com/elastic/search-ui/issues/new).
119-
120-
121-
### Where can I go to get help? [overview-where-can-i-go-to-get-help]
122-
123-
The Enterprise Search team at Elastic maintains this library and are happy to help. Try posting your question to the [Elastic Enterprise Search](https://discuss.elastic.co/c/enterprise-search/84) discuss forums. Be sure to mention that you’re using Search UI and also let us know what backend your using; whether it’s App Search, Site Search, Elasticsearch, or something else entirely.
124-
125-
126-
## Contribute 🚀 [overview-contribute]
127-
128-
We welcome contributors to the project. Before you begin, a couple notes…
129-
130-
* Read the [Search UI Contributor’s Guide](https://github.com/elastic/search-ui/blob/main/CONTRIBUTING.md).
131-
* Prior to opening a pull request:
132-
133-
* Create an issue to [discuss the scope of your proposal](https://github.com/elastic/search-ui/issues).
134-
* Sign the [Contributor License Agreement](https://www.elastic.co/contributor-agreement/). We are not asking you to assign copyright to us, but to give us the right to distribute your code without restriction. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code. You only need to sign the CLA once.
135-
136-
* Write simple code and concise documentation, when appropriate.
137-
138-
139-
## License 📗 [overview-license]
140-
141-
[Apache-2.0](https://github.com/elastic/search-ui/blob/main/LICENSE.txt) © [Elastic](https://github.com/elastic)
142-
143-
Thank you to all the [contributors](https://github.com/elastic/search-ui/graphs/contributors)! 🙏 🙏
42+
- [Search as you type](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/search-as-you-type&file=/src/pages/search-as-you-type/index.js)
43+
- [Search bar in header](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/search-bar-in-header&file=/src/pages/search-bar-in-header/index.js)
44+
- [Customizing Styles and Components](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/customizing-styles-and-html&file=/src/pages/customizing-styles-and-html/index.js)

0 commit comments

Comments
 (0)