-
Notifications
You must be signed in to change notification settings - Fork 185
[DRAFT][POC] Split Elasticsearch solution and search use case #4251
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
base: main
Are you sure you want to change the base?
Conversation
Move ES solution-specific files from /solutions/search/ to /solutions/elasticsearch-solution-project/: - Agent Builder and subdirectory - Playground files (from rag/ to top level) - Search Applications - MCP - AI Assistant - Query Rules UI - Synonyms UI pages - Get started directory These UI affordances are exclusive to the Elasticsearch solution/project type. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Create new structure separating ES solution from Search use case: - elasticsearch-solution-project.md: Overview of ES solution UI tools - elasticsearch-solution-project/get-started.md: ES solution getting started - search/get-started.md: Universal, deployment-agnostic search getting started The Elasticsearch solution provides exclusive UI affordances (Agent Builder, Playground, Search Applications UI, etc.) while the Search use case covers universal Elasticsearch primitives available across all deployments. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Update existing Search use case pages with cross-references to ES solution: - search.md: Update to "Search use case" focus, add cross-link to ES solution - search/rag.md: Update Playground references to point to ES solution location - search/apis-and-tools.md: Update generative AI tool links (Agent Builder, Playground, MCP) to new ES solution paths These updates clarify that UI tools are part of the Elasticsearch solution while universal search primitives remain in the Search use case. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Replace generic ES getting started content with ES solution-specific guide that focuses on UI tools and cross-links to universal search concepts. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Split the solutions navigation into two distinct top-level sections: 1. Search use case - Universal Elasticsearch search primitives covering: - Get started (deployment-agnostic) - Ingest for search - Search approaches (full-text, AI, vector, semantic, hybrid, ranking) - Querying methods - RAG concepts - Site/app building - Cross-cluster search - APIs and tools 2. Elasticsearch solution - UI affordances exclusive to ES solution/project: - Get started (ES solution-specific) - Agent Builder - Playground (moved from rag/ to top level) - MCP - Search Applications - Synonyms UI - Query Rules UI - AI Assistant This separation clarifies that the Search use case contains universal features available across all deployments, while the Elasticsearch solution provides exclusive UI tools for the ES solution/project type. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Remove references to quickstart files under search/get-started/ that were moved to elasticsearch-solution-project/get-started/. The search/get-started.md page already contains proper markdown links to these quickstarts in their new location. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Fix search-connection-details.md reference in ES solution get-started - Update redirects.yml to point to new file locations in elasticsearch-solution-project/get-started/ 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Fix references to quickstart files (now in elasticsearch-solution-project/get-started/) - Fix references to elastic-agent-builder (now in elasticsearch-solution-project/) - Fix references to search-with-synonyms (now in elasticsearch-solution-project/full-text/) - Update cross-references between Search use case and ES solution pages - Convert absolute URLs to relative paths 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Fix playground references from old rag/ path to new top-level location - Update MCP references to elasticsearch-solution-project - Update search-applications references to new location 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Connection details are UI-specific and belong in the ES solution section, not the universal Search use case section. Updated all references throughout the documentation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Remove marketing language, establish concrete scope immediately - Replace vague use cases table with specific application types - Remove duplicate links (Key primitives now plain text) - Expand RAG documentation references to include querying, retrievers, ranking - Remove serverless deployment tip (doesn't belong in universal search primitives) - Add direct links to relevant documentation sections 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Synonyms are search primitives available across all deployments, not exclusive to ES solution. Only the Synonyms UI is ES-solution-specific. - Move search-with-synonyms.md and create-update-synonyms-api-example.md from elasticsearch-solution-project/full-text/ to search/full-text/ - Update toc.yml to include synonyms under search/full-text - Update references in ece-ha.md - Add redirects for moved pages 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Vale Linting ResultsSummary: 19 warnings, 212 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/ai-features.md | 82 | Elastic.EndPuntuaction | Don't end headings with punctuation. |
| explore-analyze/query-filter.md | 30 | Elastic.DontUse | Don't use 'just'. |
| solutions/elasticsearch-solution-project.md | 40 | Elastic.EndPuntuaction | Don't end headings with punctuation. |
| solutions/elasticsearch-solution-project/agent-builder/mcp-server.md | 35 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'VS'. |
| solutions/elasticsearch-solution-project/agent-builder/permissions.md | 60 | Elastic.EndPuntuaction | Don't end headings with punctuation. |
| solutions/elasticsearch-solution-project/agent-builder/tools.md | 13 | Elastic.EndPuntuaction | Don't end headings with punctuation. |
| solutions/elasticsearch-solution-project/agent-builder/tools.md | 190 | Elastic.DontUse | Don't use 'Note that'. |
| solutions/elasticsearch-solution-project/agent-builder/tools/index-search-tools.md | 23 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'if needed' instead of 'ad-hoc'. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 18 | Elastic.DontUse | Don't use 'very'. |
| solutions/elasticsearch-solution-project/query-rules-ui.md | 21 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'. |
| solutions/elasticsearch-solution-project/query-rules-ui.md | 21 | Elastic.EndPuntuaction | Don't end headings with punctuation. |
| solutions/elasticsearch-solution-project/query-rules-ui.md | 71 | Elastic.DontUse | Don't use '...'. |
| solutions/elasticsearch-solution-project/query-rules-ui.md | 82 | Elastic.DontUse | Don't use '...'. |
| solutions/elasticsearch-solution-project/query-rules-ui.md | 95 | Elastic.DontUse | Don't use '...'. |
| solutions/elasticsearch-solution-project/search-applications.md | 114 | Elastic.DontUse | Don't use 'very'. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 86 | Elastic.DontUse | Don't use 'very'. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 187 | Elastic.OxfordComma | Use the Oxford comma in 'criteria, parameters and defaults.'. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 59 | Elastic.EndPuntuaction | Don't end headings with punctuation. |
| solutions/search/apis-and-tools.md | 85 | Elastic.EndPuntuaction | Don't end headings with punctuation. |
💡 Suggestions (212)
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/machine-learning/machine-learning-in-kibana/inference-processing.md | 28 | Elastic.Acronyms | 'ELSER' has no definition. |
| explore-analyze/machine-learning/machine-learning-in-kibana/inference-processing.md | 28 | Elastic.WordChoice | Consider using 'efficiently' instead of 'easily', unless the term is in the UI. |
| explore-analyze/machine-learning/machine-learning-in-kibana/inference-processing.md | 28 | Elastic.Acronyms | 'ELSER' has no definition. |
| explore-analyze/query-filter.md | 30 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/elasticsearch-solution-project.md | 15 | Elastic.Capitalization | 'solution & project type overview' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project.md | 34 | Elastic.Capitalization | 'Agent Builder' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project.md | 36 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| solutions/elasticsearch-solution-project.md | 50 | Elastic.Capitalization | 'AI Assistant' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project.md | 54 | Elastic.Capitalization | 'Model Context Protocol (MCP)' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/a2a-server.md | 11 | Elastic.Capitalization | 'Agent-to-Agent (A2A) server' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/a2a-server.md | 23 | Elastic.Capitalization | 'A2A protocol endpoint' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/agent-builder-agents.md | 41 | Elastic.WordChoice | Consider using 'copy' instead of 'clone', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/agent-builder-agents.md | 43 | Elastic.WordChoice | Consider using 'copy' instead of 'Clone', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/chat.md | 11 | Elastic.Capitalization | ': Agent Chat' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/chat.md | 32 | Elastic.Capitalization | 'Agent Chat GUI' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/chat.md | 61 | Elastic.Capitalization | 'Agent Chat API' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/get-started.md | 63 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/agent-builder/kibana-api.md | 273 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/limitations-known-issues.md | 17 | Elastic.Capitalization | 'Non-serverless deployments' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/limitations-known-issues.md | 33 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/limitations-known-issues.md | 54 | Elastic.Capitalization | 'limitations' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/limitations-known-issues.md | 81 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/limitations-known-issues.md | 87 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/mcp-server.md | 2 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/mcp-server.md | 11 | Elastic.Capitalization | 'Model Context Protocol (MCP) server' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/mcp-server.md | 68 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/mcp-server.md | 127 | Elastic.FutureTense | 'you'll receive' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/agent-builder/models.md | 27 | Elastic.Capitalization | 'Use a pre-configured connector' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/models.md | 58 | Elastic.Versions | Use 'or earlier' instead of 'or older' when referring to versions. |
| solutions/elasticsearch-solution-project/agent-builder/models.md | 62 | Elastic.Acronyms | 'GPT' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/models.md | 82 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/permissions.md | 23 | Elastic.Capitalization | 'privileges' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/permissions.md | 33 | Elastic.Capitalization | 'cluster privileges' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/permissions.md | 41 | Elastic.Capitalization | 'index privileges' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/permissions.md | 43 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/permissions.md | 46 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/permissions.md | 102 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/permissions.md | 113 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/permissions.md | 116 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/programmatic-access.md | 18 | Elastic.FutureTense | 'will probably' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/agent-builder/programmatic-access.md | 18 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/programmatic-access.md | 21 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/tools.md | 37 | Elastic.Capitalization | 'Built-in tools' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/tools.md | 58 | Elastic.WordChoice | Consider using 'efficient' instead of 'easy', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/tools.md | 200 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/tools.md | 207 | Elastic.WordChoice | Consider using 'efficient' instead of 'easy', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/tools/esql-tools.md | 13 | Elastic.Capitalization | 'tools' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/tools/esql-tools.md | 29 | Elastic.WordChoice | Consider using 'run, start' instead of 'Execute', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/tools/esql-tools.md | 51 | Elastic.FutureTense | 'will automatically' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/agent-builder/tools/esql-tools.md | 55 | Elastic.FutureTense | 'will provide' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/agent-builder/tools/esql-tools.md | 81 | Elastic.Capitalization | 'documentation' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/agent-builder/tools/index-search-tools.md | 15 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/agent-builder/tools/index-search-tools.md | 38 | Elastic.FirstPerson | Avoid first-person pronouns such as 'my'. |
| solutions/elasticsearch-solution-project/agent-builder/tools/index-search-tools.md | 48 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/elasticsearch-solution-project/agent-builder/tools/index-search-tools.md | 49 | Elastic.WordChoice | Consider using 'run, start' instead of 'Execute', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/ai-assistant.md | 8 | Elastic.Capitalization | 'AI Assistant for Elastic' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/elastic-agent-builder.md | 15 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/elastic-agent-builder.md | 31 | Elastic.Capitalization | 'Agent Chat' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/elastic-agent-builder.md | 39 | Elastic.Wordiness | Consider using 'act' instead of 'take action'. |
| solutions/elasticsearch-solution-project/get-started.md | 81 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started.md | 82 | Elastic.FutureTense | 'will use' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started.md | 100 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/elasticsearch-solution-project/get-started.md | 102 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/elasticsearch-solution-project/get-started/index-basics.md | 8 | Elastic.FutureTense | 'You'll learn' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/index-basics.md | 18 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/get-started/index-basics.md | 56 | Elastic.FutureTense | 'will automatically' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/index-basics.md | 221 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/get-started/index-basics.md | 312 | Elastic.FutureTense | 'they'll still' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/index-basics.md | 381 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/get-started/index-basics.md | 412 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/elasticsearch-solution-project/get-started/index-basics.md | 474 | Elastic.FutureTense | 'will help' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/index-basics.md | 477 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/elasticsearch-solution-project/get-started/keyword-search-python.md | 13 | Elastic.FutureTense | 'you'll index' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/keyword-search-python.md | 14 | Elastic.Repetition | "to" is repeated. |
| solutions/elasticsearch-solution-project/get-started/keyword-search-python.md | 14 | Elastic.FutureTense | 'will help' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/keyword-search-python.md | 101 | Elastic.FutureTense | 'will acknowledge' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/keyword-search-python.md | 135 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/get-started/keyword-search-python.md | 145 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/elasticsearch-solution-project/get-started/quickstarts.md | 29 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/elasticsearch-solution-project/get-started/quickstarts.md | 31 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 14 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 20 | Elastic.FutureTense | 'you'll create' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 21 | Elastic.WordChoice | Consider using 'efficient' instead of 'simple', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 21 | Elastic.FutureTense | 'you'll take' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 34 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 49 | Elastic.FutureTense | 'will have' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 76 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 76 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 96 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 100 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/get-started/semantic-search.md | 132 | Elastic.WordChoice | Consider using 'efficient' instead of 'easy', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/mcp.md | 2 | Elastic.Acronyms | 'MCP' has no definition. |
| solutions/elasticsearch-solution-project/mcp.md | 8 | Elastic.Capitalization | 'Elastic Model Context Protocol (MCP) servers' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/mcp.md | 21 | Elastic.Versions | Use 'earlier versions' instead of 'older versions' when referring to versions. |
| solutions/elasticsearch-solution-project/playground-context.md | 13 | Elastic.FutureTense | 'will generate' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/playground-context.md | 45 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/playground-context.md | 65 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/playground-context.md | 66 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/playground-query.md | 13 | Elastic.FutureTense | 'will automatically' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/playground-query.md | 24 | Elastic.WordChoice | Consider using 'efficient' instead of 'simple', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/playground-query.md | 31 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/playground-troubleshooting.md | 12 | Elastic.Capitalization | 'Troubleshooting RAG Playground' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/playground-troubleshooting.md | 24 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/playground.md | 34 | Elastic.Capitalization | 'How Playground works' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/playground.md | 136 | Elastic.Capitalization | 'Ingest data (optional)' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/playground.md | 168 | Elastic.WordChoice | Consider using 'efficiently' instead of 'easily', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/playground.md | 194 | Elastic.Wordiness | Consider using 'because' instead of 'Since'. |
| solutions/elasticsearch-solution-project/playground.md | 232 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/playground.md | 232 | Elastic.FutureTense | 'will affect' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/playground.md | 241 | Elastic.Capitalization | 'View and download Python code' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/playground.md | 243 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/query-rules-ui.md | 21 | Elastic.Capitalization | 'UI vs. API: What's the difference?' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/query-rules-ui.md | 71 | Elastic.Ellipses | In general, don't use an ellipsis. |
| solutions/elasticsearch-solution-project/query-rules-ui.md | 82 | Elastic.Ellipses | In general, don't use an ellipsis. |
| solutions/elasticsearch-solution-project/query-rules-ui.md | 95 | Elastic.Ellipses | In general, don't use an ellipsis. |
| solutions/elasticsearch-solution-project/query-rules-ui.md | 99 | Elastic.Capitalization | 'Re-order rules' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/search-applications.md | 86 | Elastic.WordChoice | Consider using 'efficient' instead of 'simple', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 17 | Elastic.Repetition | "API" is repeated. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 17 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 17 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 25 | Elastic.WordChoice | Consider using 'efficiently' instead of 'easily', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 38 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 38 | Elastic.WordChoice | Consider using 'efficient' instead of 'simple', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 49 | Elastic.FutureTense | 'will also' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 109 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 116 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 116 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 116 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 124 | Elastic.FutureTense | 'will return' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 149 | Elastic.FutureTense | 'will return' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 165 | Elastic.FutureTense | 'will execute' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 165 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 165 | Elastic.FutureTense | 'will return' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 171 | Elastic.FutureTense | 'will perform' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 179 | Elastic.Wordiness | Consider using 'some' instead of 'some of the'. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 179 | Elastic.Exclamation | Use exclamation points sparingly. Consider removing the exclamation point. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 202 | Elastic.Wordiness | Consider using 'because' instead of 'Since'. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 202 | Elastic.FutureTense | 'will still' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 207 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 207 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 209 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 214 | Elastic.Wordiness | Consider using 'impossible' instead of 'not possible'. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 217 | Elastic.Acronyms | 'PUT' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 217 | Elastic.FutureTense | 'will automatically' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 287 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 289 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 355 | Elastic.FutureTense | 'will look' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 373 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 375 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 375 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 375 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 377 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 377 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 377 | Elastic.WordChoice | Consider using 'efficient' instead of 'simple', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 482 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 482 | Elastic.FutureTense | 'will look' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 498 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 498 | Elastic.FutureTense | 'will look' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 518 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 518 | Elastic.Wordiness | Consider using 'sometimes' instead of 'in some cases'. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 524 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 536 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 538 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 592 | Elastic.FutureTense | 'will look' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 608 | Elastic.FutureTense | 'will look' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 653 | Elastic.FutureTense | 'will look' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 666 | Elastic.FutureTense | 'will look' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-api.md | 700 | Elastic.FutureTense | 'will look' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 14 | Elastic.Capitalization | 'Search Application client guide' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 22 | Elastic.WordChoice | Consider using 'copy' instead of 'Clone', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 59 | Elastic.Acronyms | 'CDN' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 77 | Elastic.Acronyms | 'CDN' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 127 | Elastic.Acronyms | 'CDN' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 129 | Elastic.Acronyms | 'CDN' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 209 | Elastic.FutureTense | 'will allow' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 223 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 236 | Elastic.FutureTense | 'will explore' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 247 | Elastic.WordChoice | Consider using 'efficient' instead of 'simple', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 247 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 306 | Elastic.Acronyms | 'ELSER' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 377 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 377 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 430 | Elastic.FutureTense | 'will return' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 458 | Elastic.FutureTense | 'will need' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 498 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 500 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 516 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 519 | Elastic.Capitalization | 'Base Filtering' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 542 | Elastic.Acronyms | 'IMDB' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-client.md | 583 | Elastic.Acronyms | 'IMBD' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 22 | Elastic.FutureTense | 'will explain' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 30 | Elastic.FutureTense | 'will cover' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 34 | Elastic.Acronyms | 'CORS' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 39 | Elastic.FutureTense | 'will create' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 74 | Elastic.FutureTense | 'will look' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 180 | Elastic.Acronyms | 'CORS' has no definition. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 182 | Elastic.FutureTense | 'will make' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 182 | Elastic.WordChoice | Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 182 | Elastic.FutureTense | 'will block' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 205 | Elastic.WordChoice | Consider using 'cannot' instead of 'unable', unless the term is in the UI. |
| solutions/elasticsearch-solution-project/search-applications/search-application-security.md | 215 | Elastic.Acronyms | 'PUT' has no definition. |
| solutions/elasticsearch-solution-project/search-connection-details.md | 19 | Elastic.Capitalization | 'Elastic Cloud and self-hosted deployments' should use sentence-style capitalization. |
| solutions/elasticsearch-solution-project/search-connection-details.md | 58 | Elastic.Wordiness | Consider using 'because' instead of 'since'. |
| solutions/elasticsearch-solution-project/search-connection-details.md | 58 | Elastic.FutureTense | 'won't appear' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/elasticsearch-solution-project/search-connection-details.md | 90 | Elastic.Wordiness | Consider using 'because' instead of 'since'. |
| solutions/elasticsearch-solution-project/search-connection-details.md | 90 | Elastic.FutureTense | 'won't appear' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/index.md | 33 | Elastic.Wordiness | Consider using 'also' instead of 'in addition'. |
| solutions/search.md | 34 | Elastic.Exclamation | Use exclamation points sparingly. Consider removing the exclamation point. |
| solutions/search/apis-and-tools.md | 81 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| solutions/search/get-started.md | 22 | Elastic.FutureTense | 'you'll need' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/search/get-started.md | 47 | Elastic.Acronyms | 'DSL' has no definition. |
| solutions/security.md | 19 | Elastic.Capitalization | 'solution & project type overview' should use sentence-style capitalization. |
External repositories (kibana, elasticsearch, beats) still reference the old paths under solutions/search/. Add redirects for: - agent-builder pages - search-applications pages - query-rules-ui - search-connection-details 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Use absolute paths throughout to make links resilient to future file moves: - Update search-templates.md references to use /solutions/search/ - Update querying-for-search.md references - Update knn.md references - Fix playground.md references (LLM guide, connectors) - Fix retrievers-overview.md playground reference - Fix search primitives link in elasticsearch-solution-project.md - Fix search-applications.md link in site-or-app.md - Fix deployment options and query languages links in get-started.md - Remove non-existent anchor reference in agent-builder/get-started.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Reverted to stepper layout to align with other solution pages and maintain the golden path onboarding flow (deployment → data → search). Incorporated new content about solution-specific features while preserving core journey. Changes: - Restored 6-step stepper format with deployment, quickstarts, goals, data, queries, and features - Moved quickstarts to optional step 2 for early hands-on experience - Added "Explore solution features" as final step (Agent Builder, Query Rules UI, synonyms) - Preserved original version as original-get-started.md for reference - Updated metadata to match original (navigation_title, description, applies_to) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
|
I've had some rough cuts at the overview pages now too: |
shainaraskas
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
still reviewing, just have to step away and am dropping some quick notes
seeing two possible gaps so far
- alternative ways of getting connection info for other solutions
- applies tags for references to elasticsearch solution features in search docs
| @@ -1,4 +1,14 @@ | |||
| redirects: | |||
| # Search primitives moved from ES solution to Search use case | |||
| 'solutions/elasticsearch-solution-project/full-text/search-with-synonyms.md': 'solutions/search/full-text/search-with-synonyms.md' | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see this page being moved in this pr
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
assuming that this list of redirects is currently incomplete
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
correct
|
|
||
| ::::{tip} | ||
| Learn how to [connect to your {{es}} endpoint](/solutions/search/search-connection-details.md). | ||
| Learn how to [connect to your {{es}} endpoint](/solutions/elasticsearch-solution-project/search-connection-details.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we care to tell people how to connect to these in other contexts, if we can assume that clients are solution-agnostic? probably a problem for later
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good q not sure, need to check what the experience is like on other project types too + if we should have a raw non-UI section for connection details
| ``` | ||
|
|
||
| For information on generating API keys, refer to [API keys](https://www.elastic.co/docs/solutions/search/search-connection-details). | ||
| For information on generating API keys, refer to [API keys](/solutions/elasticsearch-solution-project/search-connection-details.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this title no longer exists anywhere on the page. if you still prefer to use it, it should be updated
wonder if this page would be a better option
| --- | ||
|
|
||
| # Elastic Observability overview | ||
| # Elastic Observability solution & project type overview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't love the ampersand here. wonder if we can cut out any part of this because it is very long. maybe overview? I personally would drop & project type from this as well because the solution and project type are more aligned for obs/sec.
an extra space crept in
| # Elastic Observability solution & project type overview | |
| # Elastic Observability solution & project type overview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah too long and ugly agree
| ::::{step} Retrieve your settings | ||
|
|
||
| Retrieve your [{{es}} endpoint](/solutions/search/search-connection-details.md) and [API key](/deploy-manage/api-keys/elasticsearch-api-keys.md). | ||
| Retrieve your [{{es}} endpoint](/solutions/elasticsearch-solution-project/search-connection-details.md) and [API key](/deploy-manage/api-keys/elasticsearch-api-keys.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this feels like an anti-pattern (linking from one solution's docs to another) - is the process the same for observability as it is for elasticsearch? maybe deserves a backlog item for the exp team
|
|
||
| Learn more in the [Playground documentation](rag/playground.md) and try the [interactive lab](https://www.elastic.co/demo-gallery/ai-playground) for hands-on experience. | ||
| ::::{note} | ||
| Playground is available as part of the {{es}} solution and serverless project type. Learn more in the [Playground documentation](/solutions/elasticsearch-solution-project/playground.md) and try the [interactive lab](https://www.elastic.co/demo-gallery/ai-playground) for hands-on experience. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is playground a prerequisite? is there an alternative path? if there isn't, I wonder if RAG belongs in this section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
consider a serverless elasticsearch solution applies tag here
| You can use the Playground to experiment with different retriever configurations and see how they affect search results. | ||
|
|
||
| Refer to the [Playground documentation](rag/playground.md) for more information. | ||
| Refer to the [Playground documentation](/solutions/elasticsearch-solution-project/playground.md) for more information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does this need a serverless elasticsearch applies tag? is there an alternative path to using retrievers?
| - [Clients](site-or-app/clients.md): Use programming language clients to integrate {{es}} with your application. | ||
| - [Search UI](site-or-app/search-ui.md): Use the Search UI library to build a user interface for your search application. | ||
| - [Search Applications](search-applications.md): Use Search Applications to simplify the process of building search experiences, by leveraging [search templates](search-templates.md). | ||
| - [Search Applications](/solutions/elasticsearch-solution-project/search-applications.md): Use Search Applications to simplify the process of building search experiences, by leveraging [search templates](/solutions/search/search-templates.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
applies tag maybe
shainaraskas
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
prob went a little deeper than you wanted, but figured it would be good to get the feedback in now to make some shorter review cycles later :)
split overall looks really good. some key things
- the word
primitive- wonder if we can position these as ES features or capabilities rather than using that word (feels very internal) - as mentioned in my last batch of comments, worried about placement of the connection details topic
- quickstart placement
- search use case initial setup for devs / the search-curious
| ::::{step} Set up an Elastic deployment | ||
|
|
||
| If you don't already have an Elastic deployment, refer to [Select your deployment type](/solutions/search/get-started.md#choose-your-deployment-type). | ||
| If you don't already have an Elastic deployment, refer to [Get started with search](/solutions/search/get-started.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this requires specifically an elasticsearch one right? can we be more particular about the requirement?
|
|
||
| - As integrated solutions on [{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md) and [self-managed](/deploy-manage/deploy/self-managed.md) deployments | ||
| - As project types on [{{serverless-full}}](/deploy-manage/deploy/elastic-cloud/serverless.md) | ||
| - [**Search use case**](#search-use-case): Core {{es}} features accessed through APIs and client libraries, available across all [deployment types](/deploy-manage/deploy.md#choosing-your-deployment-type). Use these when you need programmatic control or the flexibility to build custom applications. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
across all solution + project types is also important here
| 1. Evaluating if an Elastic solution fits your needs. | ||
| 2. Getting started with your chosen solution. | ||
| 3. Implementing specific features and capabilities. | ||
| The [Search use case](/solutions/search.md) documents core {{es}} search capabilities available across all Elastic [deployment types](/deploy-manage/deploy.md#choosing-your-deployment-type). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need to help people to clearly differentiate between the search use case and the elasticsearch solution/project type somehow here
| ::: | ||
|
|
||
| Users reach for Elastic products, features, and tools for three main use cases: observability, security, and search. | ||
| Elastic helps you build applications for three main use cases: search, observability, and security. You can work directly with platform capabilities through APIs, use pre-built solutions with integrated UIs, or combine both approaches. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the solutions overview could use a similar hint
| Elastic helps you build applications for three main use cases: search, observability, and security. You can work directly with platform capabilities through APIs, use pre-built solutions with integrated UIs, or combine both approaches. | ||
|
|
||
| These use cases are supported by ready-to-use implementations that help you get started quickly: | ||
| This section is organized into two parts: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
perhaps we should explain this less like the organization of the section, more like "here are the paths you can follow and why"
e.g. pick a solution, or, regardless of solution, leverage search capabilities
the section isn't really in two parts per se - the use case and 3 solutions are all siblings
|
|
||
| ## Generative AI tools | ||
|
|
||
| The following generative AI tools are available as part of the {{es}} solution and serverless project type: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider some sort of value prop here - these are value adds that let you do xyz
| - file: elasticsearch-solution-project/get-started.md | ||
| children: | ||
| - file: elasticsearch-solution-project/search-connection-details.md | ||
| - file: elasticsearch-solution-project/get-started/quickstarts.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these used to be a child of get-started - any reason for splitting them out in particular?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I always felt they were a bit hidden in the nesting, and now that this new section has lots of real estate felt like a "why not?" move. LMKWYT
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but as we will seek to move them up to "search use case" we can rediscuss
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I have no strong opinion on this - just was a bit of a point of confusion
|
|
||
| The {{es}} solution and serverless project type provide specialized UI tools and interfaces that help you build search applications on top of the {{es}} platform. | ||
|
|
||
| These UI affordances are exclusive to the {{es}} **solution** (on non-serverless deployments) and the {{es}} serverless **project type**. They complement the core [search primitives](/solutions/search.md) available across all Elastic deployments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe saying explicitly "you don't need to use this solution or project type to build search" would be nice, paired with how the solution makes you go faster?
|
|
||
| ### Agent Builder | ||
|
|
||
| [Agent Builder](/solutions/elasticsearch-solution-project/elastic-agent-builder.md) enables you to create AI agents that can interact with your {{es}} data, execute queries, and provide intelligent responses. It provides a complete framework for building conversational AI experiences on top of your search infrastructure. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
snippetable
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lisa already commented on this but i agree that these are more searchy than solutiony
Co-authored-by: shainaraskas <[email protected]>
https://github.com/elastic/docs-content-internal/issues/585