Define requirements to consume Swiftype API
Goal
We would like to define requirements for about.gitlab.com to consume the Swiftype API. This will enable us to customize the search experience and execute on the parent OKR of this issue.
Jobs To Be Done
- Situation: We are using a javascript snippet from Swiftype to enable search functionality, as documented in the quick start guide here. This limits our ability to customize the experience.
-
Motivation: *We want to implement the Swiftype site search API to programmatically alter how our
- pages are crawled
- documents are indexed
- searches are completed
- analytics are generated
- and more!
- Outcome: To do this, we need to define requirements to implement the site search API on about.gitlab.com.
Page(s)
Which page(s) are involved in this request?
- about.gitlab.com - search that exists in the header
- https://swiftype.com/documentation/site-search/overview
DCI
-
DRI: @jariasc-ext -
Consulted: @laurenbarker -
Informed: Everyone
In scope
What is within scope of this request?
-
Investigate the Swiftype search API -
Create a feature branch or sandbox environment that uses the search type api -
Define requirements to implement Swiftype search API on primary header search on a about.gitlab.com -
Create issue to implement Swiftype search API
Out of scope
What is out of scope and not part of this iteration?
- This issue is not for implementing the api, is purely exploratory and to define the requirements.
Requirements
What are the requirements for this request? Checklist below is an example of common requirements, please check all that apply and adjust as necessary:
-
Copy writing -
Illustration -
Custom Graphics -
Research -
Data / Analytics -
UX Design -
Engineering
Edited by Lauren Barker