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

[Meta] [New docs] Full-text search #7753

Open
Tracked by #7401
tkajtoch opened this issue May 14, 2024 · 0 comments
Open
Tracked by #7401

[Meta] [New docs] Full-text search #7753

tkajtoch opened this issue May 14, 2024 · 0 comments
Assignees
Labels
meta New EUI site task A task associated with a larger Meta issue

Comments

@tkajtoch
Copy link
Member

tkajtoch commented May 14, 2024

Summary

We want to improve the search experience for our users and have a site-wide full-text search integrated into the new documentation page (EUI+).

Acceptance criteria

  • Full-text search should be based on Elastic App Search and have a configured indexing engine to index all contents of the main documentation site (eui.elastic.co)
    • Contents of PR environments (/pr_* paths) should be excluded from being indexed
  • It should search in page type (e.g, component or pattern), title, body, metadata (e.g., provided component export name), and other optional custom fields
  • It should provide a search field on the site's header and display search results when typing (as "autocomplete")
  • The search results should be sorted by relevance and be grouped by types (e.g., component, pattern)
  • Every production deployment should trigger site reindexing
@tkajtoch tkajtoch self-assigned this May 14, 2024
@tkajtoch tkajtoch added New EUI site meta task A task associated with a larger Meta issue labels May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta New EUI site task A task associated with a larger Meta issue
Projects
None yet
Development

No branches or pull requests

1 participant