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

[New docs] Spike: Figure out the best way to integrate full-text search into new docs #7407

Closed
Tracked by #7401
tkajtoch opened this issue Dec 7, 2023 · 1 comment
Labels
New EUI site task A task associated with a larger Meta issue

Comments

@tkajtoch
Copy link
Member

tkajtoch commented Dec 7, 2023

Summary

One of the goals for the new docs site is better searchability. We want to integrate a full-text search capability into the site based on Elastic Enterprise Search, Elastic App Search, or a local index like Lunr.js

Requirements

  • The chosen solution must allow the creation of separate indexes for each EUI version/release
  • Indexing must happen during or up to 1-hour post docs site deployment
  • It must allow extending the index to search by component prop names, export names, and others

Acceptance Criteria

  • An ADR summarizing the findings and chosen solution should be approved and merged
  • Follow-up implementation tickets should be created
@JasonStoltz JasonStoltz added the task A task associated with a larger Meta issue label Mar 28, 2024
@github-actions github-actions bot added the Stale label Oct 4, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 11, 2024
@cee-chen cee-chen reopened this Oct 14, 2024
@cee-chen cee-chen removed the Stale label Oct 14, 2024
@tkajtoch
Copy link
Member Author

We decided to use lunr.js for the time being. The implementation is done and available on EUI+

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
New EUI site task A task associated with a larger Meta issue
Projects
None yet
Development

No branches or pull requests

3 participants